pull down to refresh

Consider the process of writing the Readme for your project as the true act of creation. This is where all your brilliant ideas should be expressed. This document should stand on its own as a testament to your creativity and expressiveness. The Readme should be the single most important document in your codebase; writing it first is the proper thing to do.
Specially useful in the age of LLMs.
I started doing this recently. Instead of using Github issues to track my todos, I just put everything in my README.md. Saves time and I don't have to go hunting for my notes. When titled, "Project Requirements", my todo list becomes part of the documentation. It belongs there!
I start with a template something like this

# project title

project description

# project requirements

* [ ] help the user with x
* [x] help the user with y
* [ ] help the user with z

# dev notes

## note A

foo

## note B

bar

reply