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 # RRT Extensions
  19 There is basic RRT\* algorithm in `rrts.cc` file. To test different approaches
  20 and upgrades to RRT, *extensions* are declared in `rrtext.h` and implemented in
  21 `rrtextX.cc`, where `X` is the number of an extension.
  22
  23 ## Implemented extensions
  24 There is a list of implemented extensions and what they include:
  25 - `rrtext1.cc`: different cost for building and searching.
  26
  27 # Contribute
  28 Use [OneFlow][3] branching model and keep the [changelog][4].
  29
  30 Write [great git commit messages][5]:
  31 1. Separate subject from body with a blank line.
  32 2. Limit the subject line to 50 characters.
  33 3. Capitalize the subject line.
  34 4. Do not end the subject line with a period.
  35 5. Use the imperative mood in the subject line.
  36 6. Wrap the body at 72 characters.
  37 7. Use the body to explain what and why vs. how.
  38
  39 When adding feature or hotfix, use [Test-driven development (TDD)][2]:
  40 1. Add tests to `ut` folder, add methods declaration, basic structure.
  41 2. Run tests (just `make` in `build` folder), check that tests *fail*.
  42 3. Implement functionality.
  43 4. Run tests, check that tests *pass*.
  44 5. Refactor.
  45
  46 [2]: https://en.wikipedia.org/wiki/Test-driven_development
  47 [3]: https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow
  48 [4]: ./CHANGELOG.md
  49 [5]: https://chris.beams.io/posts/git-commit/
  50
  51 # Documentation
  52 The documentation is generated by Doxygen, at least version `1.8.15` is needed.
  53 Just run `doxygen` in the project root directory.