<project_name> is a <utility/tool/feature> that allows <insert_target_audience> to do <action/task_it_does>.
Additional line of information text about what the project does.
Before you begin, ensure you have met the following requirements:
- You have a
<Windows/Linux/Mac>
machine. State which OSs are supported and which are not. - You have installed the latest/specific version of
<coding_language/dependency/requirement_1>
. - You have read
<guide/link/documentation_related_to_project>
.
To build <project_name>, follow these steps:
Linux and macOS:
<build instructions>
Windows:
<build instructions>
To use <project_name>, follow these steps:
<usage_example>
Add additional commands and examples you think users will find useful.
To contribute to <project_name>, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Push to the original branch:
git push origin <project_name>/<location>
- Create the pull request.
Alternatively see the GitHub documentation on creating a pull request.
Licensed under MIT.