diff --git a/README.md b/README.md index 8b4c7095e..3f06d8852 100644 --- a/README.md +++ b/README.md @@ -62,12 +62,12 @@ Pre-process the extract with the car profile and start a routing engine HTTP ser The flag `-v "${PWD}:/data"` creates the directory `/data` inside the docker container and makes the current working directory `"${PWD}"` available there. The file `/data/berlin-latest.osm.pbf` inside the container is referring to `"${PWD}/berlin-latest.osm.pbf"` on the host. - docker run -t -v "${PWD}:/data" osrm/osrm-backend osrm-partition /data/berlin-latest.osm.pbf - docker run -t -v "${PWD}:/data" osrm/osrm-backend osrm-customize /data/berlin-latest.osm.pbf + docker run -t -v "${PWD}:/data" osrm/osrm-backend osrm-partition /data/berlin-latest.osrm + docker run -t -v "${PWD}:/data" osrm/osrm-backend osrm-customize /data/berlin-latest.osrm -Note that only `osrm-extract` actually uses input `.osm.pbf`. All other tools work on top of `osrm-extract` output and when `.osm.pbf` is passed to the tool it is only needed to determine "base" path and find output of `osrm-extract`, i.e. these tools will also work if just pass "base" file path(e.g. `osrm-partition /data/berlin-latest`). +Note there is no `berlin-latest.osrm` file, but multiple `berlin-latest.osrm.*` files, i.e. `berlin-latest.osrm` is not file path, but "base" path referring to set of files and there is an option to omit this `.osrm` suffix completely(e.g. `osrm-partition /data/berlin-latest`). - docker run -t -i -p 5000:5000 -v "${PWD}:/data" osrm/osrm-backend osrm-routed --algorithm mld /data/berlin-latest.osm.pbf + docker run -t -i -p 5000:5000 -v "${PWD}:/data" osrm/osrm-backend osrm-routed --algorithm mld /data/berlin-latest.osrm Make requests against the HTTP server diff --git a/docs/nodejs/api.md b/docs/nodejs/api.md index 39d0a9786..ef52ed790 100644 --- a/docs/nodejs/api.md +++ b/docs/nodejs/api.md @@ -3,8 +3,8 @@ ## OSRM The `OSRM` method is the main constructor for creating an OSRM instance. -An OSRM instance requires a `.osrm` dataset, which is prepared by the OSRM toolchain. -You can create such a `.osrm` file by running the OSRM binaries we ship in `node_modules/osrm/lib/binding/` and default +An OSRM instance requires a `.osrm.*` dataset(`.osrm.*` because it contains several files), which is prepared by the OSRM toolchain. +You can create such a `.osrm.*` dataset by running the OSRM binaries we ship in `node_modules/osrm/lib/binding/` and default profiles (e.g. for setting speeds and determining road types to route on) in `node_modules/osrm/profiles/`: node_modules/osrm/lib/binding/osrm-extract data.osm.pbf -p node_modules/osrm/profiles/car.lua @@ -12,7 +12,7 @@ profiles (e.g. for setting speeds and determining road types to route on) in `no Consult the [osrm-backend](https://github.com/Project-OSRM/osrm-backend) documentation for further details. -Once you have a complete `network.osrm` file, you can calculate routes in javascript with this object. +Once you have a complete `network.osrm.*` dataset, you can calculate routes in javascript with this object. ```javascript var osrm = new OSRM('network.osrm'); diff --git a/src/tools/customize.cpp b/src/tools/customize.cpp index c80696a5a..f77b88795 100644 --- a/src/tools/customize.cpp +++ b/src/tools/customize.cpp @@ -89,7 +89,7 @@ return_code parseArguments(int argc, const auto *executable = argv[0]; boost::program_options::options_description visible_options( - boost::filesystem::path(executable).filename().string() + " [options]"); + boost::filesystem::path(executable).filename().string() + " [options]"); visible_options.add(generic_options).add(config_options); // parse command line options diff --git a/src/tools/partition.cpp b/src/tools/partition.cpp index 861e03938..de85a6e6d 100644 --- a/src/tools/partition.cpp +++ b/src/tools/partition.cpp @@ -131,7 +131,7 @@ return_code parseArguments(int argc, const auto *executable = argv[0]; boost::program_options::options_description visible_options( - boost::filesystem::path(executable).filename().string() + " [options]"); + boost::filesystem::path(executable).filename().string() + " [options]"); visible_options.add(generic_options).add(config_options); // parse command line options