README.md

   1 # RRT\* algorithm
   2 RRTS is a C++ library with implementation of RRT\* planning algorithm.
   3
   4 # License
   5 The project is published under [GNU GPLv3][1].
   6
   7 [1]: ./LICENSE
   8
   9 # Build
  10 To build the project run the following commands:
  11 ```
  12 mkdir build
  13 cd build
  14 cmake ../
  15 make
  16 ```
  17
  18 To build with ninja:
  19 ```
  20 mkdir build
  21 cd build
  22 cmake -DCMAKE_BUILD_TYPE=Release -G Ninja ../
  23 ninja -v
  24 ```
  25
  26 # RRT Extensions
  27 There is basic RRT\* algorithm in `rrts.cc` file. To test different approaches
  28 and upgrades to RRT, *extensions* are declared in `rrtext.h` and implemented in
  29 `rrtextX.cc`, where `X` is the number of an extension.
  30
  31 ## Implemented extensions
  32 There is a list of implemented extensions and what they include:
  33 - `rrtext2.cc`: [cute c2][] for collision detection,
  34 - `rrtext1.cc`: different cost for building and searching.
  35
  36 [cute c2]: https://github.com/RandyGaul/cute_headers/blob/master/cute_c2.h
  37
  38 ## Compound extensions
  39 There is a list of classes with reference to extensions used:
  40 - `RRTCE1`: 1, 2.
  41
  42 # Contribute
  43 Use [OneFlow][3] branching model and keep the [changelog][4].
  44
  45 Write [great git commit messages][5]:
  46 1. Separate subject from body with a blank line.
  47 2. Limit the subject line to 50 characters.
  48 3. Capitalize the subject line.
  49 4. Do not end the subject line with a period.
  50 5. Use the imperative mood in the subject line.
  51 6. Wrap the body at 72 characters.
  52 7. Use the body to explain what and why vs. how.
  53
  54 When adding feature or hotfix, use [Test-driven development (TDD)][2]:
  55 1. Add tests to `ut` folder, add methods declaration, basic structure.
  56 2. Run tests (just `make` in `build` folder), check that tests *fail*.
  57 3. Implement functionality.
  58 4. Run tests, check that tests *pass*.
  59 5. Refactor.
  60
  61 [2]: https://en.wikipedia.org/wiki/Test-driven_development
  62 [3]: https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow
  63 [4]: ./CHANGELOG.md
  64 [5]: https://chris.beams.io/posts/git-commit/
  65
  66 # Documentation
  67 The documentation is generated by Doxygen, at least version `1.8.15` is needed.
  68 Just run `doxygen` in the project root directory.