Dokumentacja znajduje się w katalogu: docs. Składa się z kilku plików MarkDown.
W celu wygodniejszego czytania dokumentacji z przygotowanych plików można wygenerować stronę internetową. W tym celu
należy pobrać i zainstalować narzędzie MkDocs. Po jego zainstalowaniu
wystarczy w konsoli przejść do katalogu docs i wywołać polecenie
mkdocs serve
Oczekiwany jest rezultat podobny do poniższego:
mwasilew@DESKTOP-JJED8DN:/mnt/d/studia/6_semestr_23L/techniki_kompilacji/TKOM_projekt/docs$ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
INFO - Documentation built in 0.42 seconds
INFO - [21:42:10] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO - [21:42:10] Serving on http://127.0.0.1:8000/
Stronę internetową można teraz przeglądać pod adresem http://127.0.0.1:8000/.