mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-09-19 23:57:31 -07:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Sacha Weatherstone 2022-05-12 12:46:01 +10:00 committed by GitHub
parent 9211fa663e
commit 5a1f163e0e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
README.md
View file

@ -1,37 +1,12 @@
<!-- markdownlint-disable MD033 -->
<!-- markdownlint-disable MD041 -->
# Meshtastic
[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/Meshtastic)](https://cla-assistant.io/meshtastic/Meshtastic)
<!--Project specific badges here-->
[![CI](https://img.shields.io/github/workflow/status/meshtastic/meshtastic/CI?label=actions&logo=github&color=yellow)](https://github.com/meshtastic/meshtastic/actions/workflows/ci.yml)
[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/meshtastic)](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)
<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" target="_blank">
<img src="static/img/readme/globe.svg" width="16" />
Website
</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://meshtastic.discourse.group" target="_blank">
<img src="static/img/readme/comment-alt.svg" width="16" />
Forum
</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://discord.gg/ktMAKGBnBs" target="_blank">
<img src="static/img/readme/discord.svg" width="16" />
Discord
</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://play.google.com/store/apps/details?id=com.geeksville.mesh" target="_blank">
<img src="static/img/readme/google-play.svg" width="16" />
App
</a>
</span>
<br />
<hr />
</div>
## What is Meshtastic?
## Overview
Meshtastic® is a project that lets you use inexpensive LoRa radios as a long range off-grid communicator for areas without reliable cellular service. These radios are great for hiking, skiing, paragliding - essentially any hobby where you don't have reliable internet access. Each member of the mesh can send and view text messages and enable optional GPS based location features.
@ -41,32 +16,30 @@ Meshtastic uses LoRa for the long range communications and depending on settings
Please see our [website](https://meshtastic.org) for more information about Meshtastic.
[![Powered by Vercel](https://raw.githubusercontent.com/abumalick/powered-by-vercel/master/powered-by-vercel.svg)](https://vercel.com?utm_source=meshtastic&utm_campaign=oss)
**This repository contains the source for our website and documentation**
## Installation
## Stats
![Alt](https://repobeats.axiom.co/api/embed/e6da6ff0a9523a4eee6931d675dfeefdb7ca8692.svg "Repobeats analytics image")
## Development & Building
nodejs is required in your dev. environment. The method for installing nodejs depends on your operating system. This software is built using [Docusaurus](https://docusaurus.io).
Fork then clone the repository:
```shell
git clone https://github.com/meshtastic/meshtastic
```
Go to the root directory of your repository and install dependencies:
```shell
yarn install
pnpm install
```
Build the project with the following command
```shell
yarn build
pnpm build
```
Start a local dev. instance with the following command
```shell
yarn start
pnpm start
```