meshtastic/docs/development/reference/github.mdx

---
id: github
title: GitHub
sidebar_label: 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](https://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](https://repobeats.axiom.co/)

```markdown
# Repo name

<!--Project specific badges here-->
<!--Crowdin Badge can be generated from https://crowdin.meshtastic.org/u/projects/<project_id>/crowdsource -->

[![Crowdin](https://badges.crowdin.net/e/<badge_id>/localized.svg)](https://crowdin.meshtastic.org/<project>)
[![CI](https://img.shields.io/github/actions/workflow/status/meshtastic/<repo>/ci.yml?branch=master&label=actions&logo=github&color=yellow)](https://github.com/meshtastic/<repo>/actions/workflows/ci.yml)
[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/<repo>)](https://cla-assistant.io/meshtastic/<repo>)
[![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/)
[![Vercel](https://img.shields.io/static/v1?label=Powered%20by&message=Vercel&style=flat&logo=vercel&color=000000)](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
```