Consistent use of $ in README

This commit is contained in:
Patrick Brosi 2024-02-15 09:01:17 +01:00 committed by GitHub
parent 1752da6147
commit 76c1324353
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -25,27 +25,27 @@ For a quick visual inspection of the shape quality, see for example the schedule
Fetch this repository and init submodules: Fetch this repository and init submodules:
``` ```shell
git clone --recurse-submodules https://github.com/ad-freiburg/pfaedle $ git clone --recurse-submodules https://github.com/ad-freiburg/pfaedle
``` ```
``` ```shell
mkdir build && cd build $ mkdir build && cd build
cmake .. $ cmake ..
make -j $ make -j
``` ```
To install, type To install, type
``` ```shell
make install $ make install
``` ```
# General Usage # General Usage
## Generating shapes for a GTFS feed ## Generating shapes for a GTFS feed
``` ```shell
pfaedle -x <OSM FILE> <GTFS INPUT FEED> $ pfaedle -x <OSM FILE> <GTFS INPUT FEED>
``` ```
A shape'd version of the input GTFS feed will be written to `./gtfs-out`. A shape'd version of the input GTFS feed will be written to `./gtfs-out`.
@ -55,7 +55,7 @@ input feed. To drop all existing shapes, use the `-D` flag.
For example, you may generate (and replace existing, see `-D` flag) shapes for the GTFS dataset for Freiburg like this: For example, you may generate (and replace existing, see `-D` flag) shapes for the GTFS dataset for Freiburg like this:
``` ```shell
$ wget https://fritz.freiburg.de/csv_Downloads/VAGFR.zip $ wget https://fritz.freiburg.de/csv_Downloads/VAGFR.zip
$ wget http://download.geofabrik.de/europe/germany/baden-wuerttemberg/freiburg-regbez-latest.osm.bz2 $ wget http://download.geofabrik.de/europe/germany/baden-wuerttemberg/freiburg-regbez-latest.osm.bz2
$ pfaedle -D -x freiburg-regbez-latest.osm.bz2 VAGFR.zip $ pfaedle -D -x freiburg-regbez-latest.osm.bz2 VAGFR.zip
@ -84,8 +84,8 @@ run.
You can use the [Docker image](https://github.com/orgs/ad-freiburg/packages/container/package/pfaedle) by mounting the OSM & GTFS data into the container: You can use the [Docker image](https://github.com/orgs/ad-freiburg/packages/container/package/pfaedle) by mounting the OSM & GTFS data into the container:
```shell ```shell
docker pull ghcr.io/ad-freiburg/pfaedle:latest $ docker pull ghcr.io/ad-freiburg/pfaedle:latest
docker run -i --rm \ $ docker run -i --rm \
# mount OSM data # mount OSM data
--volume /path/to/osm/data:/osm \ --volume /path/to/osm/data:/osm \
# mount GTFS data # mount GTFS data