From 010cd593fdc7443ec203270cbf8d92fb9f0a40af Mon Sep 17 00:00:00 2001 From: Robin Lovelace Date: Wed, 16 Oct 2024 14:21:16 +0100 Subject: [PATCH] Fix typo in installation, close #84 (#85) * Fix typo in installation, close #84 * Add installation and docker sections to readme --- README.md | 14 ++++++++++++++ docs/tutorial_new_area.md | 8 +++++++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8ee015e..99ae91e 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,20 @@ You can quickly try out od2net without installing anything: Once you're ready to run in a large area with your own origin/destination data, then start with the [tutorial](docs/tutorial_examples.md) and see [all documentation](https://github.com/Urban-Analytics-Technology-Platform/od2net/tree/main/docs). Again note this project status is still pre-alpha; docs are not all written yet. +### Installation + +```shell +cargo install --locked --git https://github.com/Urban-Analytics-Technology-Platform/od2net +``` + +### Docker + +You can run the application with Docker, e.g. as follows: + +```shell +sudo docker run -v $(pwd):/app ghcr.io/urban-analytics-technology-platform/od2net:main /app/config.json +``` + ### With Python See Python scripts in the [examples](examples) directory, as described in the [tutorial](docs/tutorial_examples.md). diff --git a/docs/tutorial_new_area.md b/docs/tutorial_new_area.md index 7ce61c2..786daed 100644 --- a/docs/tutorial_new_area.md +++ b/docs/tutorial_new_area.md @@ -39,7 +39,13 @@ See [the Rust definitions](https://github.com/Urban-Analytics-Technology-Platfor ## Step 4: Running od2net -If you're working your own repo, you'll need the od2net executable installed somewhere. If you're building it yourself, then do `cargo install --locked https://github.com/Urban-Analytics-Technology-Platform/od2net`, then the `od2net` command should be added to your shell path. Or you can use Docker. +If you're working your own repo, you'll need the od2net executable installed somewhere. If you're building it yourself, then run the following command: + +```shell +cargo install --locked --git https://github.com/Urban-Analytics-Technology-Platform/od2net +``` + +This adds the `od2net` command should be added to your shell path. Or you can use Docker. So either run: