This is the name of the project. It describes the whole project in one sentence, and helps people understand what the main goal and aim of the project is.
Badges aren't necessary, but using them is a simple way of letting other developers know that you know what you're doing.
Having this section can also be helpful to help link to important tools and also show some simple stats about your project like the number of forks, contributors, open issues etc...
Below is sample badges to help users/contributors know build status of this project.
This is an important component of your project that many new developers often overlook.
Your description is an extremely important aspect of your project. A well-crafted description allows you to show off your work to other developers as well as potential employers.
Describe here the system requirements and dependencies for this project.
If you are working on a project that a user needs to install or run locally in a machine, you should include the steps required to install your project and also the required dependencies if any.
Provide a step-by-step description of how to get the development environment set and running.
This section describe on how to run your project. Go the extra mile and write tests for your application. Then provide code examples and how to run them.
This will help show that you are certain and confident that your project will work without any challenges, which will give other people confidence in it, too
This section describe on how to contribute to this project, for example :
- pull request procedure
- create issue procedure
- etc