mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-11-09 23:24:10 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Added basic installation instructions

Browse source
This commit is contained in:
nuxnik 2022-01-31 15:25:10 +01:00
parent 2d2945bfbc
commit 7a24528eb7
1 changed files with 29 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -41,3 +41,32 @@ 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)
## Installation
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:
```bash
git clone https://github.co/meshtastic/meshtastic
```
Go to the root directory of your repository and install dependencies:
```bash
yarn install
```
Build the project with the following command
```bash
yarn build
```
Start a local dev. instance with the following command
```bash
yarn start
```