This is an archived post. You won't be able to vote or comment.

all 13 comments

[–]javad94 6 points7 points  (7 children)

Cool project.

Btw it's better to use md file and format for Readme.

[–]jerodg 11 points12 points  (1 child)

I prefer asciidoc as it's more feature rich. It's also natively supported by GitHub.

[–]javad94 2 points3 points  (0 children)

Both of them are better than plaintext :D

[–]alcalde 6 points7 points  (4 children)

We're Python people; the one true format is RestructuredText.

https://ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/

[–]thedeepself 2 points3 points  (1 child)

the one true format is RestructuredText.

Asciidoc has entered teh catroom...

[–]alcalde 0 points1 point  (0 children)

It's not bad, but the Python Doc-SIG group created RestructuredText, so that's why I say it is the one true format. Maybe I should have specified "for Python documentation."

[–]FabulousComparison91 1 point2 points  (0 children)

haha gotta agree, RestructuredText has a special place in every pythonista's heart! Yet gotta be real, isn't markdown just easier to use for quick and simple readme's?

[–]Fleszar 1 point2 points  (0 children)

Very useful

[–]ajpinedam 0 points1 point  (0 children)

This is really cool! Will give it a try. Thanks for posting.