From 18e6ea9118556684781ef9e3f94c60cd9619d70b Mon Sep 17 00:00:00 2001 From: Sacha Weatherstone Date: Wed, 8 Sep 2021 18:55:06 +1000 Subject: [PATCH] Update Readme --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index ab45f5c1..4399f5b4 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ Official [Meshtastic](https://meshtastic.org) web interface, that can be run ind ## Development & Building +### Building and Packaging + Build the project: ```bash @@ -19,3 +21,29 @@ GZip the output: ```bash pnpm package ``` + +### Development + +Create a `.env` file: + +```bash +cp ./.env.example ./.env +``` + +And define the device IP address in the `.env` file. + +``` +SNOWPACK_PUBLIC_DEVICE_IP=xxx.xxx.xxx.xxx +``` + +Install the dependencies. + +```bash +pnpm i +``` + +Start the developtment server: + +```bash +pnpm start +```