3 ms·
README files are supposed to be plain text, and are generally viewed in a terminal after cloning a repo or downloading a project. Markdown isn't terrible, but o
by parliament32 8y ago
README files are supposed to be plain text, and are generally viewed in a terminal after cloning a repo or downloading a project. Markdown isn't terrible, but once you start creating massive tables like the article's linked project's readme[1], it ends up getting pretty ugly.
GNU Coding Standards explicitly defines what should be in a readme file: https://www.gnu.org/prep/standards/html_node/Releases.html#Releases https://www.gnu.org/prep/standards/html_node/Releases.html#R...
[1] https://raw.githubusercontent.com/marchowardbegins/AlgoHive/master/README.md https://raw.githubusercontent.com/marchowardbegins/AlgoHive/...