diff --git a/README.md b/README.md new file mode 100644 index 0000000..549b496 --- /dev/null +++ b/README.md @@ -0,0 +1,153 @@ +# Szablon pracy dyplomowej + +Instrukcja dla studentów: jak pobrać repozytorium i rozpocząć pisanie pracy magisterskiej w RStudio przy uzyciu formatu Markdown. + +## 1. Pobranie repozytorium + +### Opcja A: Pobieranie przez Git (zalecane) + +Jeśli masz zainstalowany Git: + +```bash +# przejdź do katalogu, w którym chcesz umieścić projekt w terminal/cmd +git clone [URL_REPOZYTORIUM] +cd "Szablon pracy dyplomowej" +``` + +### Opcja B: Pobieranie jako ZIP + +1. Kliknij zielony przycisk **Code** na stronie repozytorium +2. Wybierz **Download ZIP** +3. Rozpakuj archiwum w wybranej lokalizacji na dysku +4. Przejdź do folderu z rozpakowanymi plikami + +## 2. Instalacja oprogramowania + +### 2.1. Instalacja R + +1. Przejdź na stronę: https://cran.r-project.org/ +2. Wybierz wersję dla swojego systemu operacyjnego: + - **Windows**: kliknij "Download R for Windows" → "base" → pobierz instalator + - **macOS**: kliknij "Download R for macOS" → wybierz odpowiednią wersję dla swojego procesora (Intel/Apple Silicon) + - **Linux**: postępuj zgodnie z instrukcjami dla swojej dystrybucji +3. Uruchom pobrany instalator i postępuj zgodnie z instrukcjami +4. Zalecana wersja: R 4.3.0 lub nowsza + +### 2.2. Instalacja RStudio + +1. Przejdź na stronę: https://posit.co/download/rstudio-desktop/ +2. Przewiń w dół do sekcji **"2: Install RStudio"** +3. Pobierz wersję RStudio Desktop dla swojego systemu operacyjnego +4. Uruchom instalator i postępuj zgodnie z instrukcjami + +### 2.3. Sprawdzenie instalacji + +1. Uruchom RStudio +2. W konsoli R (dolne lewe okno) wpisz: + ```r + version + ``` +3. Powinieneś zobaczyć informacje o zainstalowanej wersji R + +## 3. Instalacja niezbędnych pakietów + +Po uruchomieniu RStudio, musisz zainstalować pakiety potrzebne do pracy z tym szablonem. + +### 3.1. Pakiety podstawowe + +W konsoli R wykonaj następujące komendy (jedna po drugiej): + +```r +# Instalacja menedżera pakietów (jeśli nie jest zainstalowany) +install.packages("pak") + +# Instalacja pakietów do pracy z Quarto i RMarkdown +install.packages("quarto") +install.packages("rmarkdown") +install.packages("knitr") + +# Pakiety do bibliografii i cytowań +install.packages("knitcitations") +install.packages("bibtex") +``` + +### 3.2. TinyTeX - instalacja LaTeX-a + +LaTeX jest niezbędny do generowania dokumentów PDF. Najłatwiejszym sposobem instalacji jest użycie pakietu `tinytex`: + +```r +# Instalacja pakietu tinytex +install.packages("tinytex") + +# Instalacja dystrybucji TinyTeX +tinytex::install_tinytex() +``` + +**Uwaga**: Instalacja TinyTeX może potrwać kilka minut. Po zakończeniu **uruchom ponownie RStudio**. + +### 3.3. Weryfikacja instalacji TinyTeX + +Po ponownym uruchomieniu RStudio sprawdź, czy TinyTeX został poprawnie zainstalowany: + +```r +tinytex::is_tinytex() +``` + +Jeśli wynik to `TRUE`, instalacja przebiegła pomyślnie. + +### 3.4. Dodatkowe pakiety LaTeX (w razie potrzeby) + +Jeśli podczas kompilacji dokumentu pojawią się błędy związane z brakującymi pakietami LaTeX, możesz je doinstalować: + +```r +# Instalacja konkretnego pakietu LaTeX +tinytex::tlmgr_install("nazwa_pakietu") + +# Przykłady często potrzebnych pakietów: +tinytex::tlmgr_install("babel-polish") +tinytex::tlmgr_install("csquotes") +tinytex::tlmgr_install("caption") +tinytex::tlmgr_install("fancyhdr") +``` + +## 4. Rozpoczęcie pracy + +1. Otwórz plik `dyplom.Rproj` - uruchomi on RStudio (podwójne kliknięcie) +2. Otwórz plik `_START.qmd` - to główny plik Twojej pracy +3. Edytuj zawartość zgodnie z wymaganiami pracy dyplomowej +4. Aby wygenerować PDF: + - Kliknij przycisk **Render** (lub naciśnij `Ctrl+Shift+K` / `Cmd+Shift+K`) + - Poczekaj na zakończenie kompilacji + - Dokument PDF pojawi się w tym samym folderze + +## 5. Struktura projektu + +- `_START.qmd` - główny plik pracy dyplomowej +- `analiza.qmd` - przykładowy rozdział z analizą danych +- `poradnik.qmd` - poradnik formatowania i pisania pracy +- `literatura.bib` - baza danych bibliograficznych (format BibTeX) +- `dyplUAM.cls` - klasa LaTeX dla formatu pracy +- `header.tex` - dodatkowe ustawienia LaTeX +- `before-body.tex` - strona tytułowa i deklaracje + +## 6. Rozwiązywanie problemów + +### Problem: Błąd podczas generowania PDF + +- Sprawdź, czy TinyTeX jest zainstalowany: `tinytex::is_tinytex()` +- Sprawdź komunikaty błędów - często wskazują na brakujące pakiety LaTeX +- Zainstaluj brakujące pakiety używając `tinytex::tlmgr_install()` + +### Problem: Encoding/znaki polskie się nie wyświetlają + +- Upewnij się, że plik jest zapisany w kodowaniu UTF-8 +- W RStudio: Tools → Global Options → Code → Saving → Default text encoding: UTF-8 + +### Problem: Bibliografia się nie generuje + +- Sprawdź, czy plik `literatura.bib` istnieje i jest poprawnie sformatowany +- Upewnij się, że w nagłówku YAML dokumentu jest podana ścieżka do pliku bibliografii + +## Pomoc + +W razie problemów skontaktuj się z promotorem