|
|
|
|
|
by throwawayboise
1699 days ago
|
|
README or INSTALL (no extension) files should be plain text, folded at 72 columns. You should assume the people actually trying to build your software are working in a shell in a terminal and using less(1) or maybe vi or some other text editor to read the README file. Even markdown is too much, though it's tolerable if named README.md so I at least can know to run it through a filter. Including icons, emojis, animations in such a file is right out. |
|
In my mind, the thing that makes Markdown a nice format (in contrast to something like ReST) is that it decomposes gracefully — the formatting indicators correspond pretty closely to the conventions that email and other plain-text mediums use. The fact that it converts to HTML is just a cherry on top.