mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-11-17 11:04:13 -08:00
90 lines
4 KiB
Plaintext
90 lines
4 KiB
Plaintext
---
|
|
id: github
|
|
title: GitHub
|
|
sidebar_label: GitHub
|
|
sidebar_position: 3
|
|
---
|
|
|
|
## Overview
|
|
|
|
The Meshtastic project is hosted on GitHub, a popular web-based platform for version control and collaborative software development. GitHub allows developers to manage and track changes to their code, collaborate with others, and distribute their work.
|
|
|
|
If you want to contribute to the Meshtastic project or simply stay up-to-date with the latest developments, you'll need a GitHub account.
|
|
|
|
## Setting up a GitHub Account
|
|
|
|
1. Go to [github.com](https://github.com)
|
|
2. Click on the "Sign up" button in the top right corner.
|
|
3. Follow the on-screen instructions to create your account.
|
|
|
|
With a GitHub account, you can:
|
|
|
|
- Access and view the Meshtastic project repositories.
|
|
- Report issues or bugs you encounter.
|
|
- Propose changes or new features through pull requests.
|
|
- Discuss and collaborate with other contributors.
|
|
|
|
## Meshtastic on GitHub
|
|
|
|
The Meshtastic project is organized under the [meshtastic GitHub organization](https://github.com/meshtastic). Here are some of the main repositories:
|
|
|
|
- [firmware](https://github.com/meshtastic/firmware): The firmware code for Meshtastic devices.
|
|
- [Meshtastic-Android](https://github.com/meshtastic/Meshtastic-Android): The Android application for Meshtastic.
|
|
- [web](https://github.com/meshtastic/web): The Meshtastic Web Client.
|
|
- [protobufs](https://github.com/meshtastic/protobufs): The Protocol Buffer definitions used by Meshtastic.
|
|
- [Meshtastic-Apple](https://github.com/meshtastic/Meshtastic-Apple): Apple iOS, iPadOS & macOS Clients For Meshtastic.
|
|
- [meshtastic](https://github.com/meshtastic/meshtastic): The Meshtastic project website and documentation.
|
|
- [python](https://github.com/meshtastic/python): The Python CLI and API for communicating with Meshtastic devices.
|
|
|
|
## Contributing to Meshtastic
|
|
|
|
If you're interested in contributing to the Meshtastic project, you'll need to follow the contribution guidelines outlined in the project's repositories. These guidelines typically include instructions for setting up your development environment, coding conventions, and the process for submitting pull requests.
|
|
|
|
Additionally, many Meshtastic repositories include a `README.md` file that provides an overview of the project, installation instructions, and other relevant information.
|
|
|
|
## README Template
|
|
|
|
Meshtastic developers are encouraged to follow a consistent README format for new repositories. The template includes sections for an overview, getting started guide, documentation/API references, installation instructions, and compatibility information.
|
|
|
|
```markdown
|
|
# Repository 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-->
|
|
|
|
Repobeats images can be generated at [repobeats.axiom.co](https://repobeats.axiom.co/)
|
|
|
|
<!--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
|
|
```
|