Modify the project title and insert the name of your project. Use Heading 1 (H1).
Provide a description of the project's functionality.
List the requirements to run the project.
Explain the steps to install your project. Include the instructions or provide links to the related documentation.
Explain how to use the project. You can create multiple subsections. Include the instructions or provide links to the related documentation.
Add instructions on how to develop the project. It must be clear what to do and how to trigger the tests so that other contributors know how to make their pull requests acceptable. Include the instructions or provide links to related documentation.