Update README to Markdown format #58
Conversation
|
Hi, please squash the commits together, so that there is a single commit, with a good log message. Also, I'm not convinced of the file name change. Perhaps we can keep the name "README"? |
Testing markdown changes Testing Draft final Final Renaming README.md to README
|
I squashed the commits (I had to learn how first!) and the filename now has no extension. But GitHub won't render the markdown properly if you don't put the .md extension on it. |
|
I've thought of this a bit more now. Actually, I'm not ready to accept this change for now. I think that reStructuredText would be a more suitable format. For example, see: https://www.ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/ I changed the READMEs of TigerVNC to reStructuredText some while ago, see: TigerVNC/tigervnc@6011f96#diff-88b99bb28683bd5b7e3a204826ead112 If you provide a similar pull request, I will accept that one. |
|
Ah, I did not know you prefer restructured text! I am not familiar with it at all, but because I am so comfortable with Markdown from my own daily usage I thought I would be able to make a quick contribution to your project by enhancing the legibility of your documentation. I totally understand that you would rather take it in a different direction for future sustainability. |
|
Hi @jasper-zanjani! I've just started helping @astrand with maintenance of this project and the world seems to mostly have settled on README.md as the defacto format. If you'd be willing to restore your fork and rename this back to .md I'd be happy to help get it merged. |
Strictly formatting changes