Prerequisites
=============
- a somewhat recent version of CMake
- a working C++14 compliant compiler

Compiling
=========
Open up a shell in the folder that this readme file is in. Then, type the
following commands in that shell:

On Windows:
mkdir build
cd build
cmake -S .. -B .
cmake --build . --config Release
cmake --install . --config Release

On Linux:
mkdir build
cd build
cmake -S .. -B . -DCMAKE_BUILD_TYPE=Release
cmake --build .
cmake --install .

You can of course change CMAKE_BUILD_TYPE to something else if you want to do 
your own development.

Running the program
===================
In the same shell that you opened up in the previous step, type the 
following command:

cd install/bin
./gtfsplanner

In order for the program to do anything useful you need to load a gtfs
dataset first. Such gtfs dataset are available for download from the web. Note
that depending on the dataset and the build (Debug vs Release), performance may
be rather poor. Calculating routes in a Debug build can easily take up to half
an hour.

Further notes
=============
This software was written for the fun of toying around with the data and as a 
hobby programming task. As a result this software is neither properly tested, 
reviewed or documented. It probably contains several bugs and could provide all
sorts of wrong results depending on the input data - though I am somewhat
confident that it would at least not blow up your computer...
If you think you can improve this software, add features, remove bugs or have
other feedback feel free to contact me. If you think this software is somewhat
cool and we happen to meet you may also buy me a beer.
