Skip to content

Commit

Permalink
Cleanup outdated config instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
jcoupey committed Mar 9, 2020
1 parent 0e234e0 commit 3132385
Showing 1 changed file with 3 additions and 23 deletions.
26 changes: 3 additions & 23 deletions README.md
Expand Up @@ -10,13 +10,7 @@
```bash
git clone https://github.com/VROOM-Project/vroom-express.git
cd vroom-express
```

- Checkout the relevant release depending on your `vroom` version

```bash
git checkout v0.4.2 # For vroom v1.4
git checkout v0.3.0 # For vroom v1.3
git checkout v0.5.0
```

- Install dependencies using `npm`
Expand All @@ -33,10 +27,6 @@ Run the server using:
npm start
```

Configuration of the server can be edited in the `./config.yml`.

Optionally prepend the command with `VROOM_ROUTER=<router>`, `router` being `osrm` (default), `libosrm` or `ors`. Using the environment variable **will override the config.yml `router` setting**.

Provided everything is fine with your VROOM and routing setup, you
should now be able to run queries like:

Expand All @@ -50,16 +40,6 @@ for input syntax.

# Customization

Launch with

```bash
node src/index.js
```

and add command-line parameters (see `args` variable at the beginning
of `src/index.js`). This includes options to:
Adjust `./config.yml` to your needs.

- adjust the max number of jobs or vehicles in handled queries;
- adjust the `vroom` exec path on the system (if not found in `$PATH`);
- set the default wrt the detailed route geometry display;
- set directory for `access.log` file;
Optionally set `VROOM_ROUTER=<router>`, `router` being `osrm` (default), `libosrm` or `ors`. Using the environment variable **will override the config.yml `router` setting**.

0 comments on commit 3132385

Please sign in to comment.