Skip to content

Commit

Permalink
Consistent use of $ in README
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickbr authored Feb 15, 2024
1 parent 1752da6 commit 76c1324
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,27 +25,27 @@ For a quick visual inspection of the shape quality, see for example the schedule

Fetch this repository and init submodules:

```
git clone --recurse-submodules https://github.com/ad-freiburg/pfaedle
```shell
$ git clone --recurse-submodules https://github.com/ad-freiburg/pfaedle
```

```
mkdir build && cd build
cmake ..
make -j
```shell
$ mkdir build && cd build
$ cmake ..
$ make -j
```

To install, type
```
make install
```shell
$ make install
```

# General Usage

## Generating shapes for a GTFS feed

```
pfaedle -x <OSM FILE> <GTFS INPUT FEED>
```shell
$ pfaedle -x <OSM FILE> <GTFS INPUT FEED>
```

A shape'd version of the input GTFS feed will be written to `./gtfs-out`.
Expand All @@ -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:

```
```shell
$ wget https://fritz.freiburg.de/csv_Downloads/VAGFR.zip
$ wget http://download.geofabrik.de/europe/germany/baden-wuerttemberg/freiburg-regbez-latest.osm.bz2
$ pfaedle -D -x freiburg-regbez-latest.osm.bz2 VAGFR.zip
Expand Down Expand Up @@ -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:

```shell
docker pull ghcr.io/ad-freiburg/pfaedle:latest
docker run -i --rm \
$ docker pull ghcr.io/ad-freiburg/pfaedle:latest
$ docker run -i --rm \
# mount OSM data
--volume /path/to/osm/data:/osm \
# mount GTFS data
Expand Down

0 comments on commit 76c1324

Please sign in to comment.