README.md

   1 BCar
   2 ====
   3
   4 BCar is a C++ library with some geometric bicycle car computations.
   5
   6 License
   7 -------
   8
   9 The project is published under [MIT License][1].
  10
  11 [1]: ./LICENSE
  12
  13 Build
  14 -----
  15
  16 To build the project run the following commands:
  17
  18     mkdir build
  19     cd build
  20     cmake ../
  21     make
  22
  23 To build with ninja:
  24
  25     mkdir build
  26     cd build
  27     cmake -DCMAKE_BUILD_TYPE=Release -G Ninja ../
  28     ninja -v
  29
  30 Contribute
  31 ----------
  32
  33 When adding feature or hotfix, use [Test-driven development][2]:
  34
  35 1. Add tests to `ut` folder, add methods declaration, basic structure.
  36 2. Run tests (just `make` in `build` folder), check that tests *fail*.
  37 3. Implement functionality.
  38 4. Run tests, check that tests *pass*.
  39 5. Refactor.
  40
  41 Write [great git commit messages][5]:
  42
  43 1. Separate subject from body with a blank line.
  44 2. Limit the subject line to 50 characters.
  45 3. Capitalize the subject line.
  46 4. Do not end the subject line with a period.
  47 5. Use the imperative mood in the subject line.
  48 6. Wrap the body at 72 characters.
  49 7. Use the body to explain what and why vs. how.
  50
  51 [2]: https://en.wikipedia.org/wiki/Test-driven_development
  52 [5]: https://chris.beams.io/posts/git-commit/
  53
  54 Documentation
  55 -------------
  56
  57 The documentation is generated by Doxygen, at least version `1.8.15` is needed.
  58 Just run `doxygen` in the project root directory.