From dcd8a341a1d37d1a2050718ce3cb45af7e35adbb Mon Sep 17 00:00:00 2001 From: muerwre Date: Mon, 27 Aug 2018 15:59:26 +0700 Subject: [PATCH] Fixed readme --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5269ca6..2276fa5 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,28 @@ # Bicycle routes map editor -Makes automated routing with OSRM and captures route screenshots. +Bicycle routes app with automatic routes, map screenshots, stickers and other features. -## Installation (in case you've forgot) +## Prerequisites +npm, php, imagemagick, osrm-server + +### Installing frontend +First, download and install the project ``` +git clone https://github.com/muerwre/orchidMap.git +cd orchidMap npm i npm start ``` + +### Setting up OSRM +Install OSRM server as written here: https://github.com/Project-OSRM/osrm-backend + +Specify country and region in osrm/prepare_maps.sh or download .pbf file from https://download.geofabrik.de/ manually. +After starting ./prepare_maps you'll get parsed .osrm files for Open Source Routing Machine server. + +Next you need to edit start_server.sh to specify address, port for server and path to parsed files. +After that run start_server.sh in screen or by the way you feel comfortable. + +### Configuring backend + +Comming soon... +