If you are interested in why I decided to organize this template in this way, maybe this article (that I wrote in Spanish) will be useful for you.
https://ivansantosgonzalez.dev/the-desired-documentation.
A brief introduction about the project and its purpose.
Basic instructions to run and use the project, here we can link the contributing section where it is explained in depth.
List of software or other things needed to launch the project and instructions about how to download and install them.
Step by step guide about how to install the project. It is something like a tutorial about the software installation (it could include images, code snippets or screenshots if it is neccessary).
Step by step guide about how to run the project. It is something like a tutorial about the project running (it could include images, code snippets or screenshots if it is neccessary).
To know more about project installation and running see Getting Started section of contributing document.
Explanation about how to contribute or work on this project. You can link to a document CONTRIBUTING.md
If you want to contribute to this project, we invite you to read the CONTRIBUTING.md document.
Explanation of the versioning standard we use and link to CHANGELOG.md
.
We use SemVer for versioning. In CHANGELOG.md you will be able to see the different versions as well as their changelogs.
Short explanation about the project license and link to the License file.
This project is licensed under the license terms of GNU GENERAL PUBLIC LICENSE Version 3 and the license file can be found in LICENSE document.
Made with ❤️and ☕ by Iván Santos