search

astrand / xclip

Command line interface to the X11 clipboard
GNU General Public License v2.0
1.04k stars 75 forks source link

Update README to Markdown format #58

Open jasper-zanjani opened 5 years ago

jasper-zanjani commented 5 years ago

Strictly formatting changes

astrand commented 5 years ago

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"?

jasper-zanjani commented 5 years ago

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.

astrand commented 5 years ago

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: https://github.com/TigerVNC/tigervnc/commit/6011f96cdc5b8f68a864d7f6294d9a45030b3533#diff-88b99bb28683bd5b7e3a204826ead112

If you provide a similar pull request, I will accept that one.

jasper-zanjani commented 5 years ago

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.