Pinned
How to Write a README That Makes Your GitHub Project Easier to Review
Your README is part of the project A working app can be difficult to evaluate when nobody knows how to run it. A README is not a marketing brochure. It is a handoff document for the next developer, re