Provide an introductory paragraph, describing:
- What your project does
- Why people should consider using your project
- Link to project home page
- About the Project
- Project Status
- Getting Started
- Release Process
- How to Get Help
- Contributing
- Further Reading
- License
- Authors
- Acknowledgments
Here you can provide more details about the project
- What features does your project provide?
- Short motivation for the project? (Don't be too long winded)
- Links to the project site
Show some example code to describe what your project does
Show some of your APIs
Show the build status if you have a CI server:
Describe the current release and any notes about the current state of the project. Examples: currently compiles on your host machine, but is not cross-compiling for ARM, APIs are not set, feature not implemented, etc.
This section should provide instructions for other developers to
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Describe what software and libraries you will need to install in order to build and use this project. Provide details on how to resolve these dependencies.
Remember: git-lfs is a dependency that developers will need to resolve before they can get started with a repository using LFS.
Examples should be included
Include a link to your GitHub repository (you have no idea how people will find your code), and also a summary of how to clone.
This project is hosted on GitHub. You can clone this project directly using this command:
git clone [email protected]:embeddedartistry/templates.git
Instructions for how to build your project
Examples should be included
Describe how to run unit tests for your project.
Examples should be included
If you have formatting checks, coding style checks, or static analysis tests that must pass before changes will be considered, add a section for those and provide instructions
Instructions for how to install your project's build artifacts
Examples should be included
Instructions for using your project. Ways to run the program, how to include it in another project, etc.
Examples should be included
If your project provides an API, either provide details for usage in this document or link to the appropriate API reference documents
Talk about the release process. How are releases made? What cadence? How to get new releases?
This project uses Semantic Versioning. For a list of available versions, see the repository tag list.
Provide any instructions or contact information for users who need to get further help with your project.
Provide details about how people can contribute to your project. If you have a contributing guide, mention it here. e.g.:
We encourage public contributions! Please review CONTRIBUTING.md for details on our code of conduct and development process.
Provide links to other relevant documentation here
Copyright (c) 2021 Embedded Artistry LLC
This project is licensed under the XXXXXX License - see LICENSE.md file for details.
- Phillip Johnston - Initial work - Embedded Artistry
Also see the list of contributors who participated in this project.
Provide proper credits, shout-outs, and honorable mentions here. Also provide links to relevant repositories, blog posts, or contributors worth mentioning.