Skip to content

Commit 193dfb3

Browse files
committed
update README
1 parent 0029bc6 commit 193dfb3

1 file changed

Lines changed: 4 additions & 8 deletions

File tree

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
11
# QuickIK
22

3-
Fast inverse kinematics library aimed for both high throughput and low latency.
3+
QuickIK is a fast inverse kinematics library written in Rust, with Python and C++ bindings.
44

5-
QuickIK provides high-level APIs for processing consecutive frames (i.e. with warm starts) and multi-threaded batch processing, as well as low-level APIs for more specific use cases (e.g. real-time application). QuickIK is written in Rust but comes with Python and C++ bindings.
6-
7-
## Documentation
8-
9-
See the [docs site](https://nely-epfl.github.io/quickik/) for installation, usage examples, and benchmarks against KDL, Pinocchio, and RBDL.
10-
11-
Not yet published to crates.io or PyPI – see [`docs/getting-started/installation.md`](docs/getting-started/installation.md) for building from a local clone.
5+
[**Documentation**](https://nely-epfl.github.io/quickik/)
126

137
## For developers
148

9+
### Toolchain
10+
1511
A series of Python tools are used for development (Python bindings build tools, linting, benchmark plotting, unit testing, etc.). These are provided in a uv-managed environment under [`devtools-pyenv/`](devtools-pyenv/). This environment is unrelated to the QuickIK Python bindings, which lives under [`python/`](python/). The rest of the section assumes you have activated this environment:
1612

1713
```sh

0 commit comments

Comments
 (0)