From d93d9711d69d6256a1a1f4993411ff63f6af19bd Mon Sep 17 00:00:00 2001 From: Ruben Barkow Date: Mon, 27 Feb 2017 06:52:16 +0100 Subject: [PATCH] [DOC] Improve README --- README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f948cfb..4d78030 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/ffrgb/meshviewer/develop.svg?style=flat-square)](https://scrutinizer-ci.com/g/ffrgb/meshviewer/?branch=develop) [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg?style=flat-square)](https://www.gnu.org/licenses/agpl-3.0) -Web-app to visualize nodes and links on a map for Freifunk open mesh network. +A web-app to visualize nodes and links on a map for Freifunk open mesh network. #### Main differences to https://github.com/ffnord/meshviewer _Some similar features might have been implemented/merged_ @@ -11,7 +11,7 @@ _Some similar features might have been implemented/merged_ - Map layer modes (Allow to set a default layer based on time combined with a stylesheet) - Automatic updates for selected node or list (incl. image stats cache-breaker) - Node filter -- Zoom level for a node (`nodeZoom`) - Zoom level 22 available, but it is to close for a click +- Zoom level for clicking on a node (`nodeZoom`) is definable independently from the maximum zoom level 22 - Formatted Code - Translation support - https://crowdin.com/project/meshviewer - Contact us for new languages - Currently available: en, de, fr & ru @@ -22,19 +22,19 @@ _Some similar features might have been implemented/merged_ - Yarn/npm in favour of bower - Load only moment.js without languages (Languages are included in translations) - unneeded components removed (es6-shim, tablesort, numeraljs, leaflet-providers, jshashes) -- RBush v2 - performance boost in last versions (Positions labels and clients on the map) +- RBush v2 - performance boost in last versions (positions, labels and clients on the map) - Ruby dependency removed - FixedCenter is required -- Sass-lint, scss and variables rewritten for easy customization/adjustments +- Sass-lint, scss and variables rewritten for easy customizations/adjustments - Cross browser/device support improved (THX@BrowserStack) - Leaflet fork with a patch to avoid IE/Edge crashes -- Yarn package manager in favor of npm (npm still works) +- Yarn package manager in favour of npm (npm still works) - Configurable reverse geocoding server - [A lot more in the commit history](https://github.com/ffrgb/meshviewer/commits/develop) -## Demo: +## Demo -Embedded: https://regensburg.freifunk.net/netz/karte/
+Embedded: https://regensburg.freifunk.net/netz/karte/ Standalone: https://regensburg.freifunk.net/meshviewer/ ## Known instances @@ -55,7 +55,7 @@ _npm is still possible to use, but yarn is much faster https://yarnpkg.com/_ Install yarn package-manager: - Chosse your OS and install yarn https://yarnpkg.com/en/docs/install + Choose your OS and install yarn https://yarnpkg.com/en/docs/install Execute these commands on your server as a normal user to prepare the dependencies: @@ -63,7 +63,7 @@ Execute these commands on your server as a normal user to prepare the dependenci git clone https://github.com/ffrgb/meshviewer.git cd meshviewer yarn -# Only needed when no global grunt is installed +# Only needed if no global grunt is installed yarn global add grunt-cli ``` @@ -75,7 +75,7 @@ Just run the following command from the meshviewer directory: grunt ``` -This will generate `build/` containing all required files. +This will generate the folder `build/` that will contain all required files. ## Development @@ -119,8 +119,7 @@ Lost will be splitted in alert and lost. ### nodeZoom (integer) -Max level to be applied by clicking a node or open a node. With value `18` near by buildings and streets should be visible. -Interesting if one of configured map provider has zoom-level under `18`. +Max level to be applied by clicking a node or opening a node. Value `18` is a good default, so nearby buildings and streets should be visible. ### labelZoom (integer)