mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-25 05:34:11 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Create README.md

Browse source 
Template by @sachaw
This commit is contained in:
Kevin Hester 2021-02-19 09:05:59 +08:00 committed by GitHub
parent cdeded6816
commit 8c4c2475a4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 121 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

121
README.md Normal file
View file

@ -0,0 +1,121 @@
<!-- markdownlint-disable MD033 -->
<!-- markdownlint-disable MD041 -->
<div align="center">
<img src="https://raw.githubusercontent.com/meshtastic/meshtastic-design/4463325bedef20be5655c91c80d1cd32a625f3ff/logo/svg/Mesh_Logo_Dynamic.svg" width="256">
<h1>Meshtastic</h1>
<span>
<a href="https://www.meshtastic.org">
<img src="assets/globe.svg" width="16" />
Website
</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://meshtastic.discourse.group">
<img src="assets/comment-alt.svg" width="16" />
Forum
</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://meshtasticdev.slack.com">
<img src="assets/slack.svg" width="16" />
Slack
</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://play.google.com/store/apps/details?id=com.geeksville.mesh">
<img src="assets/google-play.svg" width="16" />
App
</a>
</span>
<br />
<hr />
</div>
## What is Meshtastic?
<table>
<tr>
<td>
<p>
Meshtastic® is a project that lets you use inexpensive GPS mesh radios as an extensible, super long battery life mesh GPS communicator. These radios are great for hiking, skiing, paragliding - essentially any hobby where you don't have reliable internet access. Each member of your private mesh can always see the location and distance of all other members and any text messages sent to your group chat.
</p>
<p>
The radios automatically create a mesh to forward packets as needed, so everyone in the group can receive messages from even the furthest member. The radios will optionally work with your phone, but no phone is required.
</p>
</td>
</tr>
</table>
## Getting started
###### Description, should mention:
You will require atleast one of [these](https://github.com/meshtastic/meshtastic-device#supported-hardware) devices
* Link to device compatability table on `meshtastic/meshtastic-device`
* Link to flashing instructions
## Community
###### Description, should mention:
* Discussions tab: https://github.com/meshtastic/Meshtastic/discussions
* Forum
* Slack
* unofficial/international communities
* Maybe have an `awesome-meshtastic` page, have all of the apps and extensions ppl have made
## Software
###### Description
#### Meshtastic App
<table>
<tr>
<td>
<p>
The official Meshtastic Android app, It provides messaging, channel configuration and a real time map. It also has inbuilt functionality for updating device firmware over Bluetooth
</p>
</td>
</tr>
</table>
#### Meshtastic Device
<table>
<tr>
<td>
<p>
The paramount Meshtastic project, the device firmware itself. Runs on supported hardware that allows the creation of mesh networks at any scale
</p>
</td>
</tr>
</table>
#### Meshtastic.js
<table>
<tr>
<td>
<p>
TypeScript library for interfacting with Meshtastic
</p>
</td>
</tr>
</table>
#### Meshtastic-python
<table>
<tr>
<td>
<p>
Description about product
</p>
</td>
</tr>
</table>