From 1a6c525aa8be7cd9017d8e4944ecd16b4ae46eaf Mon Sep 17 00:00:00 2001 From: jee7 <raimond.tunnel@ut.ee> Date: Mon, 20 Jan 2025 00:38:37 +0000 Subject: [PATCH] Added some usage instructions to README.md --- README.md | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a7cd7bd..bc28b51 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Siin asub arvutiteaduse instituudi bakalaureuse- ja magistriأµppe lأµputأ¶أ¶de LaTeX mall. See mall on mأµeldud abistava juhendina, kuidas Teie vأµite oma lأµputأ¶أ¶d vormistada. Konkreetsete reeglite jaoks tuleks vaadata [Tartu أœlikooli arvutiteaduse instituudis kaitsvate lأµputأ¶أ¶de nأµuete ja hindamise](https://cs.ut.ee/en/content/thesis-deadlines-and-guidelines) dokumenti. -## Juhised +## أœlesseadmine ### Overleaf @@ -12,11 +12,11 @@ TODO Selleks, et kasutada seda malli **Visual Studio Code** tأ¶أ¶keskkonnas, kأµigepealt tأµmmake ja paigaldage see tأ¶أ¶keskkond: https://code.visualstudio.com/ -Visual Studio (VS) Code on paljude vأµimsate laiendustega kergeloomuline tأ¶أ¶keskkond. Selleks, et VS Code keskkonnas LaTeXiga tأ¶أ¶d teha, tuleks paigaldada jأ¤rgnevad tأ¶أ¶keskkonna laiendused: -* **LaTeX Workshop** – Pأµhiline laiendus, mis vأµimaldab LaTeXiga tأ¶أ¶d teha. -* **Hide Gitignored** – See laiendus peidab أ¤ra tأ¶أ¶keskkonna failivaaturi paneelist suurearvulised LaTeXi tأ¶أ¶failid. +Visual Studio (VS) Code on paljude vأµimsate laiendustega kergeloomuline tأ¶أ¶keskkond. Selleks, et VS Code keskkonnas LaTeX-iga tأ¶أ¶d teha, tuleks paigaldada jأ¤rgnevad tأ¶أ¶keskkonna laiendused: +* **LaTeX Workshop** – Pأµhiline laiendus, mis vأµimaldab LaTeX-iga tأ¶أ¶d teha. +* **Hide Gitignored** – See laiendus peidab أ¤ra tأ¶أ¶keskkonna failivaaturi paneelist suurearvulised LaTeX-i tأ¶أ¶failid. -Te peate ka LaTeXi eraldi oma arvutisse paigaldama. +Te peate ka LaTeX-i eraldi oma arvutisse paigaldama. #### Windowsil @@ -39,6 +39,15 @@ TODO TODO +## Kasutamine + +1. Avage juurkaustas olev `thesis.tex` ja kommenteerige sisse see rida, mis keeles Te oma lأµputأ¶أ¶d teete. +2. Minge, vastavalt oma keelevalikule, `estonian` vأµi `english` kausta. Sealt leiate faili `lأµputأ¶أ¶.tex` vأµi `thesis.tex`. Selles failis tأ¤idke أ¤ra oma lأµputأ¶أ¶ga seonduv info. Seal defineeritakse ka lأµputأ¶أ¶ dokumendis sisalduvi sektsioone. +3. Kaustas `sektsioonid` vأµi `sections` on Teie lأµputأ¶أ¶ sektsioonide failid. +4. Kaustas `joonised` vأµi `figures` on Teie lأµputأ¶أ¶ joonised. +5. Failis `seadistus.tex` vأµi `config.tex` saate seadistada oma lأµputأ¶أ¶ seadeid. Nأ¤iteks valida, millist viitamisstiili kasutada soovite. +6. Failis `viited.bib` vأµi `references.bib` on Teie lأµputأ¶أ¶ bibliograafiakirjed (soovitatav Zoterost eksportida). + ## Mured ja kontaktinfo Probleemide vأµi kأ¼simuste korral vأµtke أ¼hendust ati.study@ut.ee @@ -48,7 +57,7 @@ Probleemide vأµi kأ¼simuste korral vأµtke أ¼hendust ati.study@ut.ee Here are the LaTeX thesis templates for to help with writing your bachelor's or master's thesis at the Institute of Computer Science. The template is for guidance on how Your thesis could be formatted. For specific rules, refer to the [Guidelines for preparing and grading of graduation theses at the Institute of Computer Science of the University of Tartu](https://cs.ut.ee/en/content/thesis-deadlines-and-guidelines) document -## Instructions +## Setup ### Overleaf @@ -84,6 +93,15 @@ TODO TODO +## Usage + +1. Open the `thesis.tex` from the root folder and comment in Your chosen thesis language. In subsequent instructions, let's assume You chose English. +2. Open the folder `english` and find the file `thesis.tex`. In that file, fill in the information about Your thesis. That file also defines what sections will be included in your document. +3. The folder `sections` stores the files for Your sections. +4. The folder `figures` stores Your figure files. +5. The `config.tex` file allows You to specify some settings for Your thesis. For example, which reference style You want to use. +6. The `references.bib` file stores Your bibliography entries (ones you can export from Zotero) + ## Issues and Contact In case of problems or questions, contact ati.study@ut.ee -- GitLab