Skip to content

Commit

Permalink
adjust new city docs for #117
Browse files Browse the repository at this point in the history
  • Loading branch information
dabreegster committed Jul 2, 2020
1 parent 7d4cf4c commit eb2be71
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
14 changes: 7 additions & 7 deletions docs/dev.md
Expand Up @@ -70,18 +70,18 @@ for building those maps -- see below.
You can skip this section if you're just touching code in `game`, `ezgui`, and
`sim`.

The first stage of the importer, `--raw`, will download input files from OSM,
King County GIS, and so on. If the mirrors are slow or the files vanish, you
could fill out `data/config` and use the `updater` described above to grab the
latest input.

To run all pieces of the importer, you'll need some extra dependencies:

- `osmconvert`: See https://wiki.openstreetmap.org/wiki/Osmconvert#Download
- `libgdal-dev`: See https://gdal.org/ if your OS package manager doesn't have
this
- Standard Unix utilities: `curl`, `unzip`, `gunzip`

The first stage of the importer, `--raw`, will download input files from OSM,
King County GIS, and so on. If the mirrors are slow or the files vanish, you
could fill out `data/config` and use the `updater` described above to grab the
latest input.

You can rerun specific stages of the importer:

- If you're modifying the initial OSM data -> RawMap conversion in
Expand All @@ -97,8 +97,8 @@ You can also make the importer [import a new city](new_city.md).

## Understanding stuff

The docs listed at https://github.com/dabreegster/abstreet#documentation
explain things like map importing and how the traffic simulation works.
The docs listed at https://github.com/dabreegster/abstreet#documentation explain
things like map importing and how the traffic simulation works.

### Code organization

Expand Down
3 changes: 2 additions & 1 deletion docs/new_city.md
Expand Up @@ -8,7 +8,8 @@ hit problems. I'd really appreciate help and PRs to improve this.

If you have a `.osm` file, you can just run
`./import.sh --oneshot=/absolute/path/to/map.osm`. This tool will generate a new
file in `data/system/maps` that you can then load in the game.
file in `data/system/maps` that you can then load in the game. (If you can't run
`import.sh`, make sure you have all [dependencies](dev.md#building-map-data).

If you're using a binary release, you have to be sure to run the tool from the
`importer/` directory, so that `../data/` exists:
Expand Down

0 comments on commit eb2be71

Please sign in to comment.