README.md Content
From Logic Wiki
Typical README Contents
A README should be concise and practical, typically including:
- What the service/application does
- How to run the service locally
- How to build the project
- Development prerequisites
- Repository structure overview
- How to run tests
- Contribution guidelines
