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 RRT\* algorithm
  12 ===============
  13
  14 RRTS is a C++ library with implementation of RRT\* planning algorithm.
  15
  16 License
  17 -------
  18
  19 The project is published under [GNU GPLv3][1].
  20
  21 [1]: ./LICENSE
  22
  23 Dependencies
  24 ------------
  25
  26 - `libbcar` (as submodule)
  27 - `libjsoncpp-dev`
  28
  29 Build
  30 -----
  31
  32 To build the project run the following commands:
  33
  34     mkdir build
  35     cd build
  36     cmake ../
  37     make
  38
  39 To build with ninja:
  40
  41     mkdir build
  42     cd build
  43     cmake -DCMAKE_BUILD_TYPE=Release -G Ninja ../
  44     ninja -v
  45
  46 Contribute
  47 ----------
  48
  49 Write [great git commit messages][5]:
  50
  51 1. Separate subject from body with a blank line.
  52 2. Limit the subject line to 50 characters.
  53 3. Capitalize the subject line.
  54 4. Do not end the subject line with a period.
  55 5. Use the imperative mood in the subject line.
  56 6. Wrap the body at 72 characters.
  57 7. Use the body to explain what and why vs. how.
  58
  59 [5]: https://chris.beams.io/posts/git-commit/
  60
  61 Use [git send-email][6]:
  62
  63     git config format.subjectPrefix "PATCH rrts"
  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.
  73
  74
  75 RRT Extensions
  76 ==============
  77
  78 There is basic RRT\* algorithm in `rrts.cc` file. To test different approaches
  79 and upgrades to RRT, _extensions_ are declared in `rrtext.hh` and implemented in
  80 `src/rrtextN.cc`, where `N` is the number of an extension.
  81
  82 For more information, see the `incl/rrtext.hh` header file or the generated
  83 documentation.
  84
  85 RRT extensions are not to be used as the final planner. Instead, the _RRT*
  86 planners_ declared in `incl/rrtsp.hh` are to be used as the final planner.