Daily trip price calculator {#mainpage}
===========================

About
-----
This amazing program computes the average price of a trip spanning 
between two user given dates.

Build
-----
You will need a C++14 compatible compiler.
To build this code you just need to do the following:
    
    mkdir bin
    make -jN

where N is the number of available processes.

Documentation
-------------
To build this documentation you can use the following commands:
    * `make doc`: will build the documentation.
    * `make html`: open the `html` documentation in your browser.
    * `make pdf`: open the `pdf` documentation using `evince`.

Program usage
-------------
`./bin/ex1_trip [sday] [smonth] [syear]  [eday] [emonth] [eyear]`

Quick documentation overview:
-----------------------------
Here are the two main classes used by this project:
    1. #Date ([date.h](@ref date.h) and [date.cpp](@ref date.cpp)): 
        Implementation of basic dates functionalities
    2. #Trip ([trip.h](@ref trip.h) and [trip.cpp](@ref trip.cpp)): 
    Implementation of trips.

Some utility function are hidden in [utils.h](@ref utils.h) 
and [utils.cpp](@ref utils.cpp).

The main function is hidden in [main.cpp](@ref main.cpp).