![]() Programmers of the original mainframe computers which came with punch cards, would leave a stack of paper instructions with “READ ME!” written across the front. Although the origin of the name README is disputed, the two most popular theories are: The oldest example I could find was this README for DEC's PDP-10 computer which is dated 27th November 1974. There's evidence that READMEs date back as far as the 1970s. ![]() Even a README file's name in all-caps is designed to catch your reader's attention and ensure it is the first thing they read. It is usually the most visible piece of documentation and landing page for most open source projects. md) that acts as the one-stop shop documentation for a project or directory. TL DR - Too long? Skip to the end and use my template.Įssentially a README is a single text file (. If you write a README without sufficient explanation of what your project does or how people can use it then it pretty much defeats the purpose of being open source as other developers are less likely to engage with or contribute towards it. A good README not only informs people what the project does and who it is for but also how they use and contribute to it. Arguably the single most important piece of documentation for any open source project is the README.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |