diff --git a/doc/examples/config.json b/doc/examples/config.json index ea35046c..aacdcb6a 100644 --- a/doc/examples/config.json +++ b/doc/examples/config.json @@ -1,6 +1,6 @@ { "race-name": "AC35", - "time-scale": 1.0, + "time-scale": 2.0, "race-size": 6, "teams": [ { diff --git a/doc/user_manual.md b/doc/user_manual.md index 7c571c01..0ca79deb 100644 --- a/doc/user_manual.md +++ b/doc/user_manual.md @@ -1 +1,15 @@ -# User Manual \ No newline at end of file +# User Manual + +## Running the application + +When you execute the application, it will try to load a configuration file called config.json located in doc/examples/. + +You can specify a config file using the using the -f flag, for example 'java -jar app.jar -f doc/examples/config1.json' + +## The config file + +The teams/boats are specified in the config file under 'teams', each team requires a team name, and a velocity (in meters per second). + +The 'time-scale' option lets you change how long the race takes to complete. A time-scale of 1.0 is normal speed, 2.0 is 2x etc. + +The 'race-size' option lets you specify how many boats will be selected to compete in each race. There must be at least this many teams defined. \ No newline at end of file