Update 'README.md'

This commit is contained in:
Mikael Capelle 2018-02-24 22:22:26 +00:00
parent 45d63615c6
commit 8e8c34c26e

View File

@ -2,7 +2,7 @@
To clone this repository: To clone this repository:
``` ```bash
# You need the --recursive option (--recurse-submodules with Git >= 2.13), # You need the --recursive option (--recurse-submodules with Git >= 2.13),
# you can use https or ssh, it does not matter. # you can use https or ssh, it does not matter.
git clone --recursive https://gitea.typename.fr/INSA/be-graphes-map-generator.git git clone --recursive https://gitea.typename.fr/INSA/be-graphes-map-generator.git
@ -15,7 +15,7 @@ bash init.sh
If you do not plan on generating maps with coastline for mapsforge (see below), you can use the `--no-shapefile` option If you do not plan on generating maps with coastline for mapsforge (see below), you can use the `--no-shapefile` option
to avoid the download: to avoid the download:
``` ```bash
bash init.sh --no-shapefile bash init.sh --no-shapefile
``` ```
@ -37,7 +37,7 @@ You can download PBF files for multiple regions on Geofabrik: [https://download.
You should put the PBF file in subfolders, e.g. if you want to use `bretagne.pbf`, you should save it to: You should put the PBF file in subfolders, e.g. if you want to use `bretagne.pbf`, you should save it to:
``` ```bash
inputs/bretagne/bretagne.pbf inputs/bretagne/bretagne.pbf
``` ```
@ -49,7 +49,7 @@ Only manual generation is supported as of now:
#### Mapsforge file: #### Mapsforge file:
``` ```bash
# You do not need to specify a bounding-box if you did not use the coastline fix or # You do not need to specify a bounding-box if you did not use the coastline fix or
# do not want it. # do not want it.
bin/osmosis --rb inputs/bretagne/bretagne_merge.pbf \ bin/osmosis --rb inputs/bretagne/bretagne_merge.pbf \
@ -59,7 +59,7 @@ bin/osmosis --rb inputs/bretagne/bretagne_merge.pbf \
#### Binary graph files #### Binary graph files
``` ```bash
# You do not need to specify a bounding box if you do not need it. You can use either "insa2016" or # You do not need to specify a bounding box if you do not need it. You can use either "insa2016" or
# "insa2018" writers, and you should change the map id to your need. # "insa2018" writers, and you should change the map id to your need.
bin/osmosis --rb inputs/bretagne/bretagne-latest.osm.pbf \ bin/osmosis --rb inputs/bretagne/bretagne-latest.osm.pbf \
@ -76,7 +76,7 @@ The fix is an adaptation from [https://github.com/mapsforge/mapsforge-creator](h
You will first need a PBF file and its associated polygon file, you can get these from [https://download.geofabrik.de/index.html](https://download.geofabrik.de/index.html). You need to put those file in a region folder, e.g. if you want to fix `bretagne`, you should have: You will first need a PBF file and its associated polygon file, you can get these from [https://download.geofabrik.de/index.html](https://download.geofabrik.de/index.html). You need to put those file in a region folder, e.g. if you want to fix `bretagne`, you should have:
``` ```bash
# Do not rename these files! # Do not rename these files!
inputs/bretagne/bretagne-latest.osm.pbf inputs/bretagne/bretagne-latest.osm.pbf
inputs/bretagne/bretagne.poly inputs/bretagne/bretagne.poly
@ -86,7 +86,7 @@ You should also have run the `init.sh` script without the `--no-shapefile` optio
Once you have the requested files, you can simply run (from the `inputs` folder): Once you have the requested files, you can simply run (from the `inputs` folder):
``` ```bash
# If you are not already in the inputs folder # If you are not already in the inputs folder
cd inputs cd inputs