README.md

   1 # I am car, too
   2 *I am car, too* puts together multiple libraries and run some automated parking
   3 tests.
   4
   5 # License
   6 The project is published under [MIT License][1].
   7
   8 [1]: ./LICENSE
   9
  10 # Build
  11 To build the project run the following commands:
  12 ```
  13 mkdir build
  14 cd build
  15 cmake ../
  16 make
  17 ```
  18
  19 ## Required libraries
  20 - `libjsoncpp-dev`
  21 - `libpsp` (depends on `libbcar`, `libpslot`)
  22 - `librrts` (depends on `libbcar`)
  23
  24 # Contribute
  25 Use [OneFlow][3] branching model and keep the [changelog][4].
  26
  27 Write [great git commit messages][5]:
  28 1. Separate subject from body with a blank line.
  29 2. Limit the subject line to 50 characters.
  30 3. Capitalize the subject line.
  31 4. Do not end the subject line with a period.
  32 5. Use the imperative mood in the subject line.
  33 6. Wrap the body at 72 characters.
  34 7. Use the body to explain what and why vs. how.
  35
  36 When adding feature or hotfix, use [Test-driven development (TDD)][2]:
  37 1. Add tests to `ut` folder, add methods declaration, basic structure.
  38 2. Run tests (just `make` in `build` folder), check that tests *fail*.
  39 3. Implement functionality.
  40 4. Run tests, check that tests *pass*.
  41 5. Refactor.
  42
  43 [2]: https://en.wikipedia.org/wiki/Test-driven_development
  44 [3]: https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow
  45 [4]: ./CHANGELOG.md
  46 [5]: https://chris.beams.io/posts/git-commit/
  47
  48 # Documentation
  49 The documentation is generated by Doxygen, at least version `1.8.15` is needed.
  50 Just run `doxygen` in the project root directory.