GitHub
Overview
All of Meshtastic's code and documentation is hosted on GitHub. If you would like to contribute to the project, having a GitHub account is an important step to doing so.
Set up GitHub account
- Go to github.com
- Click
Sign Up
README Template
All Meshtastic developers should follow this convention when writing a README for a repository.
Repobeats images can be generated at repobeats.axiom.co
# Repo name
<!--Project specific badges here-->
<!--Crowdin Badge can be generated from https://crowdin.meshtastic.org/u/projects/<project_id>/crowdsource -->
[](https://crowdin.meshtastic.org/<project>)
[](https://github.com/meshtastic/<repo>/actions/workflows/ci.yml)
[](https://cla-assistant.io/meshtastic/<repo>)
[](https://opencollective.com/meshtastic/)
[](https://vercel.com?utm_source=meshtastic&utm_campaign=oss)
## Overview
A description about the project
**[Getting Started Guide](https://example.com)**
**[Documentation/API Reference](https://example.com)**
## Stats
<!--Repobeats image here-->
<!--If the repository is a library, include this section-->
## Installation & Usage
<!--You may optionally include brief install/update instructions here-->
<!--Any other pertinent sections-->
### Compatibility