From ccc7c684feff148c0beee4787c72ebc9df026a40 Mon Sep 17 00:00:00 2001 From: Andrew Chou Date: Wed, 8 May 2024 18:15:51 -0400 Subject: [PATCH] update readme --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5c921b2a..81802d33 100644 --- a/README.md +++ b/README.md @@ -19,19 +19,30 @@ For a mobile application that is compatible with Mapeo Desktop, see [Mapeo Mobil Read the [online user guide](https://digital-democracy.gitbook.io/mapeo/) for information on how to install aerial imagery and tiles, custom configurations, -and more. +and more. ![architecture](docs/desktop-architecture.png) ## Getting Started -To clone and install all dependencies and start a process to re-build the app whenever you change a file: +To clone and install all dependencies: ```sh git clone git@github.com:digidem/mapeo-desktop.git cd mapeo-desktop npm install npm run build:translations +``` + +Create a `.env` file at the project root that has the following structure (replace `` with a valid [Mapbox public access token](https://docs.mapbox.com/help/getting-started/access-tokens/)): + +```env +MAPBOX_ACCESS_TOKEN= +``` + +Start a process to re-build the app whenever you change a file: + +```sh npm run watch ``` @@ -57,7 +68,6 @@ tail -f USERDATA/Mapeo/logs/$DATE.debug.log See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for more details. - ## Community Connect with the Mapeo community for support & to contribute!