Skip to content

Commit 67e690f

Browse files
Update README.md
1 parent 2f0a513 commit 67e690f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,9 @@ pip install --no-index --find-links=./dist franky-panda
109109
```
110110

111111
Franky is based on [libfranka](https://github.com/frankaemika/libfranka), [Eigen](https://eigen.tuxfamily.org) for transformation calculations and [pybind11](https://github.com/pybind/pybind11) for the Python bindings.
112-
Franky uses the [Ruckig](https://ruckig.com) Community Version for Online Trajectory Generation (OTG).
113-
As the Franka is quite sensitive to acceleration discontinuities, it requires constrained jerk for all motions.
114-
After installing the dependencies (the exact versions can be found below), you can build and install franky via
112+
As the Franka is sensitive to acceleration discontinuities, it requires jerk-constrained motion generation, for which franky uses the [Ruckig](https://ruckig.com) community version for Online Trajectory Generation (OTG).
115113

114+
After installing the dependencies (the exact versions can be found [here](#development)), you can build and install franky via
116115
```bash
117116
git clone --recurse-submodules git@github.com:timschneider42/franky.git
118117
cd franky
@@ -123,13 +122,13 @@ make
123122
make install
124123
```
125124

126-
To use franky, you can also include it as a subproject in your parent CMake via `add_subdirectory(franky)` and then `target_link_libraries(<target> libfranky)`. If you need only the Python module, you can install franky via
125+
To use franky, you can also include it as a subproject in your parent CMake via `add_subdirectory(franky)` and then `target_link_libraries(<target> libfranky)`.
127126

127+
If you need only the Python module, you can install franky via
128128
```bash
129129
pip install .
130130
```
131-
132-
Make sure that the built library can be found from Python by adapting your Python Path.
131+
Make sure that the built library `_franky.cpython-3**-****-linux-gnu.so` is in the Python path, e.g. by adjusting `PYTHONPATH` accordingly.
133132

134133

135134
#### Using Docker
@@ -563,6 +562,7 @@ Franky is written in C++17 and Python3.7. It is currently tested against followi
563562
- Libfranka v0.7.1, v0.8.0, v0.9.2, v0.10.0, v0.11.0, v0.12.1, v0.13.3
564563
- Eigen v3.4.0
565564
- Pybind11 v2.11.1
565+
- Python 3.7, 3.8, 3.9, 3.10, 3.11, 3.12
566566
- Catch2 v2.13.8 (for testing only)
567567

568568
## License

0 commit comments

Comments
 (0)