2 SPDX-FileCopyrightText: 2021 Jiri Vlasak <jiri.vlasak.2@cvut.cz>
4 SPDX-License-Identifier: GPL-3.0-only
10 BCar is a C++ library with some geometric bicycle car computations.
15 The project is published under [GNU GPLv3][1].
22 To build the project run the following commands:
33 cmake -DCMAKE_BUILD_TYPE=Release -G Ninja ../
39 When adding feature or hotfix, use [Test-driven development][2]:
41 1. Add tests to `ut` folder, add methods declaration, basic structure.
42 2. Run tests (just `make` in `build` folder), check that tests *fail*.
43 3. Implement functionality.
44 4. Run tests, check that tests *pass*.
47 Write [great git commit messages][5]:
49 1. Separate subject from body with a blank line.
50 2. Limit the subject line to 50 characters.
51 3. Capitalize the subject line.
52 4. Do not end the subject line with a period.
53 5. Use the imperative mood in the subject line.
54 6. Wrap the body at 72 characters.
55 7. Use the body to explain what and why vs. how.
57 [2]: https://en.wikipedia.org/wiki/Test-driven_development
58 [5]: https://chris.beams.io/posts/git-commit/
63 The documentation is generated by Doxygen, at least version `1.8.15` is needed.
64 Just run `doxygen` in the project root directory.