Esta tarea se ha implementado en parte en feature#370
Es necesario crear y estructurar las secciones que el README debe contener. There are several official guides and resources for writing a README file. Here are a few:
GitHub's guide on creating a README file. This guide provides a basic overview of what a README file is and what it should contain.
Make a README: This is a guide that explains the importance of a README and what sections it should contain. It also provides a README template.
Awesome README: A curated list of awesome READMEs. It includes examples of great READMEs from various open-source projects.
Standard Readme: A specification for README files for code projects. It provides a set of rules and an example structure for a standard README.
README file should include the following sections:
Project Title
Description
Installation
Usage
Contributing
License
Contact Information
Our README might also include other sections. The goal is to provide enough information for someone else to understand what our project is, why it's useful, and how they can use it.
It'll be able contains GUIDELINES portions.
[x] Make a list of improvements ("content", "structural") based on guidelines and model with focus: are the "basic" checked? then list the key improvements.
[x] Create a local README_copy.md and update very basics
[x] Review the list and README_copy.md
[x] Progress on edition by 09/04/2024 available branch feature#370 (this is based on the list of the file: readmeGuigelinesNotes.txt)
Esta tarea se ha implementado en parte en feature#370
Es necesario crear y estructurar las secciones que el README debe contener. There are several official guides and resources for writing a README file. Here are a few:
GitHub's guide on creating a README file. This guide provides a basic overview of what a README file is and what it should contain.
Make a README: This is a guide that explains the importance of a README and what sections it should contain. It also provides a README template.
Awesome README: A curated list of awesome READMEs. It includes examples of great READMEs from various open-source projects.
Standard Readme: A specification for README files for code projects. It provides a set of rules and an example structure for a standard README.
README file should include the following sections:
README will be write only in English