Too Long; Didn't Read
The open-source community has opened over 400 000 pull requests during October alone. The pillar of any open source project is the readme.md file. It contains all necessary information for understanding the direction the project is heading. The most important part is that it contains steps to get the software running on your local machine for development purposes. But, it should also contain steps to deploy the software to production as well. Make A Readme walks you through the whole process of writing an awesome readme.