search

UniversalDependencies / docs

Universal Dependencies online documentation
http://universaldependencies.org/
Apache License 2.0
267 stars 245 forks source link

readme file extensions #813

Open AleksandrsBerdicevskis opened 2 years ago

AleksandrsBerdicevskis commented 2 years ago

Readme files for individual treebanks in the 2.8.1 release (and I guess earlier ones, too) are sometimes README.md (e.g. Akkadian-PISANDUB), and sometimes README.txt (e.g. Afrikaans-AfriBooms), which makes automatic processing a tiny bit more complicated.

manning commented 2 years ago

Maybe this is just how life is? Certainly GitHub allows either, and you can either write markdown if you wish or just have a text file if you wish. Presumably it's not that hard to first try for README.md and then to try README.txt if it doesn't exist?

dan-zeman commented 2 years ago

Our infrastructure tries both (but will allow just one of them to exist).

On the other hand, allowing .txt has historical reasons and and is a bit obsolete because we have moved to requiring certain MarkDown-formatted headings inside.