Dokumentatsioon puudub
Closed this issue · 5 comments
Puudub dokumentatsioon, kuidas programme kasutada.
Kataloogis doc on kompileerimisjuhend.
Kompileeritud programmi käivitamisel kuvatakse kasutusjuhend.
Analüsaatori ja süntesaatori projektikaustades on näite-sisend-failid.
Kompileerimis- ja kasutusjuhend koos kasutusnäidetega võiks olla juurkataloogi README failis, nagu teistel korralikel githubi projektidel.
Tänan ettepaneku eest.
Lisasin hetkel eeloleva info hetkel doc/radme.html faili.
Püüame dokumentatsiooni aja jooksul parendada ja teha kasutajasõbralikumaks.
Ma ikkagi pooldaks seda, et see Issue pandaks kinni siis, kui elementaarne dokumentatsioon on juurkakataloogi README's. Siis näeks seda kohe, kui githubis projekti lehele minna.
Sain muide nende kommentaaride abil etana tööle.
Ma pooldan samuti, et käesoleva Issue panna kinni, siis kui käesolev probleem on lahendatud, mida ilmselgelt pole. Mina poleks kindlasti selle teabe peale sattunud, ja võib-olla poleks julgend küsidagi.