From e73938f4e356ebdeade562e8c6fefac7cf1cbfca Mon Sep 17 00:00:00 2001 From: Norbert Renner Date: Fri, 17 Jan 2020 12:25:01 +0100 Subject: [PATCH] Update readme installation instructions for standalone zip --- README.md | 46 ++++++++++------------------------------------ 1 file changed, 10 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 72aec61..c30b01d 100644 --- a/README.md +++ b/README.md @@ -33,55 +33,29 @@ click **Translate** to start translating. As an alternative to the above online version, the standalone server of BRouter can also be run on your local desktop. -### Install BRouter (server with routing engine) +### Install standalone zip (client and server) -1. download and unzip latest [BRouter revision](https://brouter.de/brouter/revisions.html) - e.g. for Linux (replace `~/opt/` with your preferred install directory and `1_4_11` with latest version): +1. download and unzip latest standalone archive (`brouter-web-standalone..zip`) from https://github.com/nrenner/brouter-web/releases e.g. for Linux (replace `~/opt/` with your preferred install directory and `0.11.0` with latest version): mkdir ~/opt/brouter cd ~/opt/brouter - wget https://brouter.de/brouter_bin/brouter_1_4_11.zip - unzip brouter_1_4_11.zip - chmod +x ./standalone/server.sh + wget https://github.com/nrenner/brouter-web/releases/download/0.11.0/brouter-web-standalone.0.11.0.zip + unzip brouter-web-standalone.0.11.0.zip + chmod +x ./run.sh ./standalone/local.sh 2. download one or more [data file(s)](https://brouter.de/brouter/segments4/) (rd5) into `segments4` directory -### Install BRouter-Web (client) +### Configure BRouter-Web -1. download BRouter-Web as subdirectory `brouter-web` of the `brouter` directory +In the `brouter-web` subdirectory: - - using the latest stable release - adjust to current version number - from - https://github.com/nrenner/brouter-web/releases: - - wget https://github.com/nrenner/brouter-web/releases/download/0.7.0/brouter-web-0.7.0.zip - unzip brouter-web-0.7.0.zip -d brouter-web - - - OR the current development state (potentially instable and without runtime distributables): - - wget https://github.com/nrenner/brouter-web/archive/master.zip - unzip master.zip - mv brouter-web-master brouter-web - - - build the distributable files required for runtime (only for development state), see section [Build](#build) - -2. copy `config.template.js` to `config.js` -3. configure URL to `profiles2` directory - set `BR.conf.profilesUrl` in config.js, e.g. uncomment: - - BR.conf.profilesUrl = 'http://localhost:8000/profiles2/'; - -4. add your API keys (optional) +1. copy `config.template.js` to `config.js` +2. add your API keys (optional) copy `keys.template.js` to `keys.js` and edit to add your keys ### Run -1. start BRouter server in the `standalone` directory with `./server.sh` or `server.cmd` (Windows) -2. serve the `brouter` directory for BRouter-Web - This is needed for pre-loading the selected profile (unless you allowed local file access in the Browser). Depending on your setup (see [How to run things locally](https://threejs.org/docs/#manual/en/introduction/How-to-run-things-locally)), start a web server in the `brouter` directory, e.g.: - - python -m SimpleHTTPServer - -3. open http://localhost:8000/brouter-web/ +1. start `./run.sh` ## Build