README.md

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