search

twoolie / NBT

Python Parser/Writer for the NBT file format, and it's container the RegionFile.
MIT License
362 stars 74 forks source link

Restore README.txt for packaging #111

Closed mfld-fr closed 5 years ago

mfld-fr commented 5 years ago

In a previous commit, I wiped out README.txt because it was a plain-text duplicate of README.md, but I missed the former was used for the Python packaging.

So restored that file, updated by the way the Python releases in both, and verified the markup with rst2html as explained here: https://docs.python.org/3.7/distutils/packageindex.html#package-display

macfreek commented 5 years ago

Thanks for the link. It seems that the documentation can expect either plain text (txt) or restructuredRext (rst), but not MarkDown (md). GitHub on the other hand expects MarkDown for the readme file, but does not support RestructuredText for the README (as far as I can find), despite that the wiki here on GitHub requires RestructuredText.

Hmmm. The tool we use for documentation (Sphinx) can do rst-to-md, but I don't know of an easy was to do md-to-rst. That would prevent us from keeping two variants of the same file.

As an alternative we can use doc/index.rst instead of README.md/README.txt.

mfld-fr commented 5 years ago

Yeah, several design options are available, but I would merge this one before improving the whole, because I feel uncomfortable until my mistake is fixed.

macfreek commented 5 years ago

Don't feel uncomfortable:)

mfld-fr commented 5 years ago

Thanks for the merge !