Filosoft / vabamorf

Eesti keele morfanalüsaator
Other
24 stars 14 forks source link

Dokumentatsioon puudub #1

Closed alumae closed 10 years ago

alumae commented 10 years ago

Puudub dokumentatsioon, kuidas programme kasutada.

PRR24 commented 10 years ago

Kataloogis doc on kompileerimisjuhend. Kompileeritud programmi käivitamisel kuvatakse kasutusjuhend. Analüsaatori ja süntesaatori projektikaustades on näite-sisend-failid.

alumae commented 10 years ago

Kompileerimis- ja kasutusjuhend koos kasutusnäidetega võiks olla juurkataloogi README failis, nagu teistel korralikel githubi projektidel.

PRR24 commented 10 years ago

Tänan ettepaneku eest. Lisasin hetkel eeloleva info hetkel doc/radme.html faili. Püüame dokumentatsiooni aja jooksul parendada ja teha kasutajasõbralikumaks.

alumae commented 10 years ago

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.

kristiank commented 10 years ago

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.