From 7a24528eb7797a89a88603bd14e35d6a1d9994d8 Mon Sep 17 00:00:00 2001 From: nuxnik <17590223+nuxnik@users.noreply.github.com> Date: Mon, 31 Jan 2022 15:25:10 +0100 Subject: [PATCH] Added basic installation instructions --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 403032c2..c1717a7c 100644 --- a/README.md +++ b/README.md @@ -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 +```