Readme files are meant to be written and read. This collection over videos mentions some things you can do to make them stand out a bit more.
There are a few important parts of a readme.
- You'll want to name your project and in a sentence explain what it does.
- You'll want to explain how to install it.
- You'll want to demonstrate basic usage. Full documentation is for someplace else.
Your readme should always have these three elements. Note that you're not just doing this for other people. You're also doing this for your future self.
If you are hosting an open source project it might also make sense to explicitly mention the license and to mention how people can contribute.
Just for reference.
# indicates a header. A single
# will turn into a large header
h1 html tag to be precise).
The smallest header is started with six bangs
(which generates a
You can create code snippets with three ticks ```.
Feedback? See an issue? Something unclear? Feel free to mention it here.
If you want to be kept up to date, consider getting the newsletter.