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 Merged into http://rtime.felk.cvut.cz/gitweb/hubacji1/iamcar2.git
   8
   9 Not updated anymore.
  10
  11 BCar
  12 ====
  13
  14 BCar is a C++ library with some geometric bicycle car computations.
  15
  16 License
  17 -------
  18
  19 The project is published under [GNU GPLv3][1].
  20
  21 [1]: ./LICENSE
  22
  23 Build
  24 -----
  25
  26 To build the project run the following commands:
  27
  28     mkdir build
  29     cd build
  30     cmake ../
  31     make
  32
  33 To build with ninja:
  34
  35     mkdir build
  36     cd build
  37     cmake -DCMAKE_BUILD_TYPE=Release -G Ninja ../
  38     ninja -v
  39
  40 Contribute
  41 ----------
  42
  43 When adding feature or hotfix, use [Test-driven development][2]:
  44
  45 1. Add tests to `ut` folder, add methods declaration, basic structure.
  46 2. Run tests (just `make` in `build` folder), check that tests *fail*.
  47 3. Implement functionality.
  48 4. Run tests, check that tests *pass*.
  49 5. Refactor.
  50
  51 Write [great git commit messages][5]:
  52
  53 1. Separate subject from body with a blank line.
  54 2. Limit the subject line to 50 characters.
  55 3. Capitalize the subject line.
  56 4. Do not end the subject line with a period.
  57 5. Use the imperative mood in the subject line.
  58 6. Wrap the body at 72 characters.
  59 7. Use the body to explain what and why vs. how.
  60
  61 [2]: https://en.wikipedia.org/wiki/Test-driven_development
  62 [5]: https://chris.beams.io/posts/git-commit/
  63
  64
  65 Use [git send-email][6]:
  66
  67     git config format.subjectPrefix "PATCH bcar"
  68     git config sendemail.to "jiri.vlasak.2@cvut.cz"
  69
  70 [6]: https://git-send-email.io/
  71
  72 Documentation
  73 -------------
  74
  75 The documentation is generated by Doxygen, at least version `1.8.15` is needed.
  76 Just run `doxygen` in the project root directory.