README files

Jump to bottom

Barrie Byron edited this page Jul 10, 2023 · 7 revisions

README files are the welcome sign for the project and form the first impression of the project for new users and potential contributors.

README content

Title
A few short statements describing why your project exists and what it does
Installation and dependencies
Usage instructions
How users can get help
Links to essential documentation
Link to your project's license

Nice to haves

Table of contents
Tech stack and features
A link to a working instance
A screenshot of the project's user interface
Link to contributing guidelines
Link to code of conduct
Badges
Tests
Code examples and how to run them