README.md

   1 __I am car, too__ puts together some libraries to run some tests on some
   2 scenarios.
   3
   4 The project is published under [GNU GPLv3][1].
   5
   6 [1]: ./LICENSE
   7
   8 Build
   9 -----
  10
  11 To build the project run the following commands:
  12
  13     mkdir build
  14     cd build
  15     cmake ../
  16     make
  17
  18 To build with ninja:
  19
  20     mkdir build
  21     cd build
  22     cmake -DCMAKE_BUILD_TYPE=Release -G Ninja ../
  23     ninja -v
  24
  25 Scenarios
  26 =========
  27
  28 All the scenarios are in the directories named `scenarios-*`. Each scenario
  29 contains at least `init`, `slot`, and the list of `obst`acles.
  30
  31 Tests
  32 =====
  33
  34 Tests are build from within the cmake file. Tests are named `testN` where `N` is
  35 the test's identifier. All tests expects JSON fromatted scenario on standard
  36 input and outputs JSON that can vary, but at minimum contains `goal` computed
  37 for the parking `slot`, `path` from `init` to `goal` that avoid `obst`acles, if
  38 such a path exists, `goal_cc` (cumulative cost), and elapsed `time`.
  39
  40 Input and/or otput of the tests can be plotted with
  41 `plot_json_objects_scenario.py` script.
  42
  43 `src/` directory contains templates used to build tests.