Skip to content

Commit 1c86c4e

Browse files
Update the README
1 parent 85917f5 commit 1c86c4e

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
The **bipedal-locomotion-framework** project is a _suite_ of libraries for achieving bipedal locomotion on humanoid robots.
2525
# Table of content
2626

27-
- [Table of content](#table-of-content)
2827
- [:page\_facing\_up: Mandatory dependencies](#page_facing_up-mandatory-dependencies)
2928
- [:orange\_book: Exported components](#orange_book-exported-components)
3029
- [:package: Install with conda (recommended)](#package-install-with-conda-recommended)
@@ -62,17 +61,17 @@ The **bipedal-locomotion-framework** project consists of several components. The
6261
| [`Math`](./src/Math) | Library containing mathematical algorithms | [`manif`](https://github.com/artivis/manif) |
6362
| [`ML`](./src/ML) | Library containing deep learning algorithms | [`onnxruntime`](https://onnxruntime.ai/) |
6463
| [`ParametersHandler`](./src/ParametersHandler) | Library for retrieving parameters from configuration files | [`YARP`](https://www.yarp.it/git-master/) (only if you want the `YARP` implementation) [`tomlplusplus`](https://github.com/marzer/tomlplusplus/) (only if you want the `toml` implementation) |
65-
| [PerceptionInterface](./src/RobotInterface) | Generic interface classes to adapt to perception data formats like images and point clouds | [`OpenCV`](https://github.com/opencv/opencv) [`PCL`](https://github.com/PointCloudLibrary/pcl) |
66-
| [PerceptionCapture](./src/Perception) | Library containing driver classes for perception devices | [`OpenCV`](https://github.com/opencv/opencv) [`PCL`](https://github.com/PointCloudLibrary/pcl) [`realsense2`](https://github.com/IntelRealSense/librealsense) |
67-
| [PerceptionFeatures](./src/Perception) | Library containing perception algorithms useful for locomotion | [`OpenCV`](https://github.com/opencv/opencv) |
64+
| [`PerceptionInterface`](./src/RobotInterface) | Generic interface classes to adapt to perception data formats like images and point clouds | [`OpenCV`](https://github.com/opencv/opencv) [`PCL`](https://github.com/PointCloudLibrary/pcl) |
65+
| [`PerceptionCapture`](./src/Perception) | Library containing driver classes for perception devices | [`OpenCV`](https://github.com/opencv/opencv) [`PCL`](https://github.com/PointCloudLibrary/pcl) [`realsense2`](https://github.com/IntelRealSense/librealsense) |
66+
| [`PerceptionFeatures`](./src/Perception) | Library containing perception algorithms useful for locomotion | [`OpenCV`](https://github.com/opencv/opencv) |
6867
| [`Planners`](./src/Planners) | Library containing planner useful for locomotion | [`manif`](https://github.com/artivis/manif) [`CasADi`](https://web.casadi.org/) [`qhull`](http://www.qhull.org/) |
6968
| [`ReducedModelControllers`](./src/ReducedModelsController) | Controller based on reduced models, e.g., `CentroidalMPC` | [`CasADi`](https://github.com/casadi/casadi)|
7069
| [`RobotInterface`](./src/RobotInterface) | Library for communicating with the robot | [`YARP`](https://www.yarp.it/git-master/) (only if you want the `YARP` implementation) |
71-
| [SimplifiedModelControllers](./src/SimplifiedModelControllers) | Controllers based on simplified models, i.e, LIPM. | - |
72-
| [System](./src/System) | Description of discrete and continuous dynamical systems | - |
73-
| [TSID](./src/TSID) | Task space inverse dynamics | [`manif`](https://github.com/artivis/manif) [`lie-group-controllers`](https://github.com/ami-iit/lie-group-controllers) |
74-
| [TextLogging](./src/TextLogging) | Helper library to display messages into the console | [`YARP`](https://www.yarp.it/git-master/) (only if you want the `YARP` implementation) [`ros-humble`](https://docs.ros.org/en/humble/) (if you want the `ros2` implementation) |
75-
| [YarpUtilities](./src/YarpUtilities) | Utilities library for retrieving data and from YARP structures | [`YARP`](https://www.yarp.it/git-master/) |
70+
| [`SimplifiedModelControllers`](./src/SimplifiedModelControllers) | Controllers based on simplified models, i.e, LIPM. | - |
71+
| [`System`](./src/System) | Description of discrete and continuous dynamical systems | - |
72+
| [`TSID`](./src/TSID) | Task space inverse dynamics | [`manif`](https://github.com/artivis/manif) [`lie-group-controllers`](https://github.com/ami-iit/lie-group-controllers) |
73+
| [`TextLogging`](./src/TextLogging) | Helper library to display messages into the console | [`YARP`](https://www.yarp.it/git-master/) (only if you want the `YARP` implementation) [`ros-humble`](https://docs.ros.org/en/humble/) (if you want the `ros2` implementation) |
74+
| [`YarpUtilities`](./src/YarpUtilities) | Utilities library for retrieving data and from YARP structures | [`YARP`](https://www.yarp.it/git-master/) |
7675

7776
:warning: Including `BipedalLocomotion/Framework.h` may result in higher compilation time because of the inclusion of headers which may not be used in your project. It is always suggested to follow the [IWYU](https://github.com/include-what-you-use/include-what-you-use/blob/cc0fad4be0db26e40713b6076263f204a311b573/docs/WhyIWYU.md) paradigm. This applies also for the CMake targets. It is suggested to link only the targets used in your project.
7877

@@ -127,7 +126,7 @@ cmake --build . --config Release --target install
127126
# :running: How to use the libraries
128127
The **bipedal-locomotion-framework** provides native `CMake` support which allows the library to be easily used in `CMake` projects.
129128

130-
**bipedal-locomotion-framework** exports the `CMake` targets presented in [Exported components](#orange_book-exported-components) section. The targets can be imported using the `find_package` command and used by calling `target_link_libraries`.
129+
**bipedal-locomotion-framework** exports the `CMake` targets presented in [Exported components](#orange_book-exported-components) section. The targets can be imported using the `find_package` command and used by calling `target_link_libraries`.
131130

132131
For instance, `Math` component can be used as follows:
133132

@@ -139,6 +138,8 @@ add_executable(example example.cpp)
139138
target_link_libraries(example PRIVATE BipedalLocomotion::Math)
140139
```
141140

141+
The list of the targets can be found in the table [:orange\_book: Exported components](#orange_book-exported-components).
142+
142143
# :gear: Contributing
143144

144145
**bipedal-locomotion-framework** is an open-source project, and is thus built with your contributions. We strongly encourage you to open an issue with your feature request. Once the issue has been opened, you can also proceed with a pull-request :rocket:

0 commit comments

Comments
 (0)