mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-02-02 08:42:11 -08:00
45 lines
1.3 KiB
Plaintext
45 lines
1.3 KiB
Plaintext
---
|
|
id: readmes
|
|
title: README Structure
|
|
sidebar_label: READMEs
|
|
---
|
|
|
|
## Outline
|
|
|
|
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-->
|
|
[](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 pertenant sections-->
|
|
### Compatibility
|
|
```
|
|
|