Skip to content

Commit

Permalink
Fix typo in installation, close #84 (#85)
Browse files Browse the repository at this point in the history
* Fix typo in installation, close #84

* Add installation and docker sections to readme
  • Loading branch information
Robinlovelace authored Oct 16, 2024
1 parent 7dc7c73 commit 010cd59
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
8 changes: 7 additions & 1 deletion docs/tutorial_new_area.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit 010cd59

Please sign in to comment.