bcar/README.md

   1 <!--
   2 SPDX-FileCopyrightText: 2021 Jiri Vlasak <jiri.vlasak.2@cvut.cz>
   3
   4 SPDX-License-Identifier: GPL-3.0-only
   5 -->
   6
   7 BCar
   8 ====
   9
  10 BCar is a C++ library with some geometric bicycle car computations.
  11
  12 License
  13 -------
  14
  15 The project is published under [GNU GPLv3][1].
  16
  17 [1]: ./LICENSE
  18
  19 Build
  20 -----
  21
  22 To build the project run the following commands:
  23
  24     mkdir build
  25     cd build
  26     cmake ../
  27     make
  28
  29 To build with ninja:
  30
  31     mkdir build
  32     cd build
  33     cmake -DCMAKE_BUILD_TYPE=Release -G Ninja ../
  34     ninja -v
  35
  36 Contribute
  37 ----------
  38
  39 When adding feature or hotfix, use [Test-driven development][2]:
  40
  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*.
  45 5. Refactor.
  46
  47 Write [great git commit messages][5]:
  48
  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.
  56
  57 [2]: https://en.wikipedia.org/wiki/Test-driven_development
  58 [5]: https://chris.beams.io/posts/git-commit/
  59
  60
  61 Use [git send-email][6]:
  62
  63     git config format.subjectPrefix "PATCH bcar"
  64     git config sendemail.to "jiri.vlasak.2@cvut.cz"
  65
  66 [6]: https://git-send-email.io/
  67
  68 Documentation
  69 -------------
  70
  71 The documentation is generated by Doxygen, at least version `1.8.15` is needed.
  72 Just run `doxygen` in the project root directory.