Skip to content

Commit

Permalink
Remove docu build from README
Browse files Browse the repository at this point in the history
As we deploy documentation through GithubPages this could be confusing

Signed-off-by: Niklas Spielbauer <[email protected]>
  • Loading branch information
nspielbau committed Oct 29, 2024
1 parent 56aece9 commit 062f63c
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 12 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

- Removed doc build instructions from Readme

### Fixed

[unreleased]: https://github.com/fzi-forschungszentrum-informatik/ros2_ros_bt_py/compare/v0.1.0...main
Expand Down
12 changes: 0 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,6 @@ This is a [Behavior Tree](https://en.wikipedia.org/wiki/Behavior_tree_(artificia

It includes a ReactJS-based web GUI and all the building blocks you need to build moderately advanced mission control Behavior Trees without writing a single line of code!

## Documentation

The main documentation effort is found in the `doc`folder.
Simply execute the following commands in your shell to get browsable HTML documentation, including some tutorials:

```bash
$ cd ros_bt_py/doc
$ make html
$ cd build
$ python -m http.server & xdg-open http://localhost:8000/html
```

## Installation

To actually start using ros_bt_py, you need to install its dependencies first:
Expand Down

0 comments on commit 062f63c

Please sign in to comment.