3 ms·
A good description of what the project does, installation instructions, and decent example usage where appropriate. I like to show: 1. What it is. 2. How
by stevekemp 4y ago
A good description of what the project does, installation instructions, and decent example usage where appropriate.
I like to show:
1. What it is.
2. How to install it.
3. What command-line flags there are, for CLI apps, or what the API is for embedding if a shared library.
4. Notes on how to run the tests.
5. A comment about reporting bugs.
Some projects have more sections, others less, but I think clear instructions for downloading/using, as well as a "What even is this?" is a good start.