From 51a037cc284cb9358e6c64a3125386fbf48685f3 Mon Sep 17 00:00:00 2001 From: Raimund Renkert Date: Thu, 3 Mar 2022 15:28:53 +0100 Subject: [PATCH] Updated README and README of web map client. --- README.md | 2 ++ cmd/mtwebmapper/client/README.md | 9 ++++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index be590a5..186c24e 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,8 @@ the map has to be pre-rendered with **mtseeder**. it makes sense to do only small updates on pre-calculated images instead of generating the map entirely on the fly. +* [Web-Map-Client](https://bitbucket.org/s_l_teichmann/mtsatellite/src/master/cmd/mtwebmapper/client) Web map application showing the base map of the minetest world and other in the browser. + This is Free Software under the terms of the MIT license. See [LICENSE](LICENSE) file for details. (c) 2014 by Sascha L. Teichmann diff --git a/cmd/mtwebmapper/client/README.md b/cmd/mtwebmapper/client/README.md index 1ccbdbb..aa1695f 100644 --- a/cmd/mtwebmapper/client/README.md +++ b/cmd/mtwebmapper/client/README.md @@ -1,6 +1,10 @@ -# client +# Minetest Web-Map-Client + +The web map client for mtsatellite is build as vue app using vuetify and leaflet as frameworks. +The following commands are all you need to set this application up. ## Project setup + ``` yarn install ``` @@ -14,6 +18,7 @@ yarn serve ``` yarn build ``` +The result of this command is a ```dist``` folder containing the minified version. To use this in production, copy or move the folder to the location of your choice to serve the app. ### Lints and fixes files ``` @@ -21,4 +26,6 @@ yarn lint ``` ### Customize configuration +To configure the backend websocket URL and the app title adjust the entries in the ```.env``` file. + See [Configuration Reference](https://cli.vuejs.org/config/).