Skip to content

Commit 47bee48

Browse files
Fix some typos in the README (#758)
1 parent 552b9e5 commit 47bee48

File tree

1 file changed

+10
-18
lines changed

1 file changed

+10
-18
lines changed

README.md

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
<a href="https://github.com/ami-iit/bipedal-locomotion-framework/actions?query=workflow%3A%22C%2B%2B+CI+Workflow%22"><img src="https://github.com/ami-iit/bipedal-locomotion-framework/workflows/C++%20CI%20Workflow/badge.svg" alt="CI"/></a>
1010
</p>
1111

12-
1312
---
1413

1514
<p align="center">
@@ -20,10 +19,8 @@
2019
---
2120

2221

23-
2422
The **bipedal-locomotion-framework** project is a _suite_ of libraries for achieving bipedal locomotion on humanoid robots.
2523
# Table of content
26-
2724
- [:page\_facing\_up: Mandatory dependencies](#page_facing_up-mandatory-dependencies)
2825
- [:orange\_book: Exported components](#orange_book-exported-components)
2926
- [:package: Install with conda (recommended)](#package-install-with-conda-recommended)
@@ -37,10 +34,9 @@ The **bipedal-locomotion-framework** project is a _suite_ of libraries for achie
3734
# :page_facing_up: Mandatory dependencies
3835
The **bipedal-locomotion-framework** project is versatile and can be used to compile only some components.
3936

40-
The minimum required dependencies are `Eigen3`, `iDynTree` and `spdlog`. If you want to build the tests please remember to install `Catch2`. If you are interested in the python bindings generation please install `python3` and `pybind11` in your system.
37+
The minimum required dependencies are `Eigen3`, `iDynTree` and `spdlog`. If you want to build the tests please remember to install `Catch2`. If you are interested in the Python bindings generation please install `python3` and `pybind11` in your system.
4138

4239
# :orange_book: Exported components
43-
4440
The **bipedal-locomotion-framework** project consists of several components. The components are stored in the [`src`](./src) folder and their compilation depends on the installed dependencies.
4541

4642
| Component | Description | Additional Dependencies |
@@ -73,22 +69,22 @@ The **bipedal-locomotion-framework** project consists of several components. The
7369
| [`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) |
7470
| [`YarpUtilities`](./src/YarpUtilities) | Utilities library for retrieving data and from YARP structures | [`YARP`](https://www.yarp.it/git-master/) |
7571

76-
: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.
72+
: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 to the CMake targets. It is suggested to link only the targets used in your project.
7773

7874
# :package: Install with conda (recommended)
79-
You can easily the library with [`conda`](https://anaconda.org/robotology/bipedal-locomotion-framework) using the following command
75+
You can easily the library with [`conda`](https://anaconda.org/conda-forge/bipedal-locomotion-framework) using the following command
8076

8177
```console
8278
conda install -c conda-forge bipedal-locomotion-framework
8379
```
8480

85-
`conda` will automatically install all the required dipendencies.
81+
`conda` will automatically install all the required dependencies.
8682

8783

8884
# :hammer: Build the suite
8985
The **bipedal-locomotion-framework** can be built on Windows, macOS, and Linux. The easiest way to compile the library is to use the [`robotology-superbuild`](https://github.com/robotology/robotology-superbuild). If you enable the profiles `ROBOTOLOGY_ENABLE_DYNAMICS` and `ROBOTOLOGY_ENABLE_DYNAMICS_FULL_DEPS` in the `robotology-superbuild` you will automatically clone and build **bipedal-locomotion-framework** and all the dependencies.
9086

91-
If you do not want to use the `robotology-superbuild` you can manually compile the code in the repository running the following command in the terminal
87+
If you do not want to use the `robotology-superbuild` you can manually compile the code in the repository by running the following command in the terminal
9288

9389
```sh
9490
git clone https://github.com/ami-iit/bipedal-locomotion-framework.git
@@ -102,12 +98,10 @@ cmake --build . --config Release --target install
10298
**Remark:** If you manually compile the framework remember to install the dependencies required by the component you are interested in.
10399

104100
# :computer: Some utilities
105-
106101
The **bipedal-locomotion-framework** ships also some utilities that can help you in the everyday tests on a real robot. You can find them in the [`utilities` folder](./utilities). Each utility contains a well-documented` README` where you can find further details.
107102

108103
# :snake: Python
109-
110-
**bipedal-locomotion-framework** provides also python bindings. Only a small set of the components implemented in the library have the corresponding python bindings.
104+
**bipedal-locomotion-framework** also provides Python bindings. Only a small set of the components implemented in the library have the corresponding Python bindings.
111105

112106
If you want to compile the bindings please install `python3` and `pybind11` in your system then you can run the following `CMake` command in your `build` folder
113107

@@ -121,14 +115,14 @@ cmake -DCMAKE_INSTALL_PREFIX=<path/where/you/want/to/install> \
121115
cmake --build . --config Release --target install
122116
```
123117

124-
**Disclaimer:** The python bindings are currently supported on Linux.
118+
**Disclaimer:** The Python bindings are currently supported on Linux.
125119

126120
# :running: How to use the libraries
127121
The **bipedal-locomotion-framework** provides native `CMake` support which allows the library to be easily used in `CMake` projects.
128122

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`.
123+
**bipedal-locomotion-framework** exports the `CMake` targets presented in the [Exported components](#orange_book-exported-components) section. The targets can be imported using the `find_package` command and used by calling `target_link_libraries`.
130124

131-
For instance, `Math` component can be used as follows:
125+
For instance, the `Math` component can be used as follows:
132126

133127
```cmake
134128
cmake_minimum_required(VERSION 3.0)
@@ -141,10 +135,8 @@ target_link_libraries(example PRIVATE BipedalLocomotion::Math)
141135
The list of the targets can be found in the table [:orange\_book: Exported components](#orange_book-exported-components).
142136

143137
# :gear: Contributing
144-
145-
**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:
138+
**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:
146139

147140
# :technologist: Maintainers
148-
149141
* Giulio Romualdi ([@GiulioRomualdi](https://github.com/GiulioRomualdi))
150142
* Stefano Dafarra ([@S-Dafarra](https://github.com/S-Dafarra))

0 commit comments

Comments
 (0)