From b28c3f4efaf284dec31256f717c3c50e32278aa7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franti=C5=A1ek=20Boh=C3=A1=C4=8Dek?= Date: Tue, 29 Jun 2021 20:45:46 +0200 Subject: [PATCH] docs: add readme with documentation info --- docs/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000000000000000000000000000000000..cbf46ad60e46eda616bb5e743fe98808531dea1d --- /dev/null +++ b/docs/README.md @@ -0,0 +1,12 @@ +* Dokumentace semestrální práce + +** Manuál (česky) +Manuál společně s návodem, jak program zkompilovat a spustit lze najít v souboru user-manual.pdf. + +** Kód (anglicky) +Dokumentace kódu byla vygenerována přes Doxygen a její vstupní html index +se nachází v `doxy/html/index.html` + +** Blokové schéma (anglicky) +Diagramy s blokovým schématem programů se nachází ve složce diagrams/, +nachází se zde 3 diagramy, pro každý program zvlášť.