4 BCar is a C++ library with some geometric bicycle car computations.
9 The project is published under [MIT License][1].
16 To build the project run the following commands:
27 cmake -DCMAKE_BUILD_TYPE=Release -G Ninja ../
33 When adding feature or hotfix, use [Test-driven development][2]:
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*.
41 Write [great git commit messages][5]:
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.
51 [2]: https://en.wikipedia.org/wiki/Test-driven_development
52 [5]: https://chris.beams.io/posts/git-commit/
57 The documentation is generated by Doxygen, at least version `1.8.15` is needed.
58 Just run `doxygen` in the project root directory.