The README should provide a clear overview of the most important information about the project.
At the top level, it should briefly describe what the project is about and how it can be executed, built and tested. At the lower level, details such as the workflow, licence or other more specific things can be included.
For the sake of simplicity, I would only consider the top level part to be necessary here, if you are bored you can still do the lower level part of the README.
theadell
commented
6 months ago
The README should provide a clear overview of the most important information about the project.
At the top level, it should briefly describe what the project is about and how it can be executed, built and tested. At the lower level, details such as the workflow, licence or other more specific things can be included.
For the sake of simplicity, I would only consider the top level part to be necessary here, if you are bored you can still do the lower level part of the README.