amuthesis/README.md

21 lines
1.9 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Klasa `amuthesis`
Klasa `amuthesis` została stworzona z myślą o studentach ostatnich lat studiów licencjackich, inżynierskich i magisterskich na Wydziale Matematyki i Informatyki Uniwersytetu im. Adama Mickiewicza w Poznaniu, choć równie dobrze może być wykorzystywana na innych uczelniach. Dobrym zwyczajem jest bowiem składać prace dyplomowe z wykorzystaniem systemu LaTeX i bynajmniej nie dotyczy to wyłącznie prac z matematyki i informatyki. Niestety, samodzielnie przygotowanie wszystkich elementów składowych pracy dyplomowej wymaga nie tylko zaawansowanej znajomości systemu LaTeX oraz zasad rządzących składem tekstu, ale przede wszystkim czasu. Klasa `amuthesis` dostarcza więc wszystko to, co jest potrzebne do stworzenia pięknej pracy dyplomowej w języku polskim lub w języku angielskim.
## Zawartość repozytorium
Główny plik klasy `amuthesis`, nazwany `amuthesis.cls`, zawiera definicje poleceń i otoczeń przydatnych w czasie tworzenia pracy dyplomowej. Opiera się przy tym na standardowych klasach: `book` dla prac w języku angielskim oraz `mwbk` dla prac w języku polskim. Klasa `amuthesis` współpracuje z najpopularniejszymi silnikami LaTeXa:
* `pdflatex`
* `xelatex`
* `lualatex`
Poza tym, repozytorium zawiera dodatkowe pliki:
* `amuthesis-doc.tex` oraz `amuthesis-doc.pdf` pliki te zawierają opis możliwości klasy,
* `thesis.tex` oraz `thesis.pdf` pliki te stanowią szkielet, na którym można oprzeć swoją pracę dyplomową,
* `uam-logo.pdf` plik zawiera logo UAM, które może być wykorzystane na stronie tytułowej pracy.
## Jak używać klasy `amuthesis`?
* [Pobierz](https://github.com/bprzybylski/amuthesis/archive/master.zip) i wypakuj archiwum `zip` z aktualną zawartością repozytorium.
* Zapoznaj się z zawartością pliku `amuthesis-doc.pdf`.
* Uzupełnij plik `thesis.tex` treścią i skompiluj go z wykorzystaniem jednego z trzech wymienionych wyżej kompilatorów.