search

tibirna / qgit

Official git repository for QGit.
Other
175 stars 68 forks source link

Rename README to README.adoc(?) to enable rendering on GitHub? #73

Closed hartwork closed 5 years ago

hartwork commented 5 years ago

Hi!

Thanks a bunch for QGit! Since gitg keeps crashing on me to the point of not starting up at all for some repositories, QGit is a great thing to have, and its unique approach to visualization has turned out helpful a few times already — thanks!

I noticed that README uses special syntax but it's not rendered by GitHub due to lack of a file extension. It looks like reStructuredText to me. Are there reasons to not rename it to README.rst to keep rendering disabled?

Best, Sebastian

tibirna commented 5 years ago

Hello Sebastian

Warmest thanks for your very kind words.

Reason for not using .rst extension is majorly my ignorance. I might have known the reStructuredText notions some time ago, but I seem to not have noticed it in the README created by the original QGit author.

Thanks for noticing. I'll test and then proceed to the suggested modification.

Thanks Cristian

tibirna commented 5 years ago

Upon trying my local installation of docutils' rst2html converter, I can see a rather large number of formating issues. So I will not proceed to the renaming for now, the raw text is still better readable than the rendering.

Thanks again

hartwork commented 5 years ago

Would you welcome a pull request fixing the syntax to be valid reStructuredText, Markdown, or AsciiDoc?

tibirna commented 5 years ago

Of course! Thanks in advance!

hartwork commented 5 years ago

Turns out it was supposed to be Asciidoc, not reStructuredText. Way better! Please check if #74 looks like the way forward.

tibirna commented 5 years ago

Merged. Thank you very much for the contribution!