Skip to content

Commit 2b96074

Browse files
committed
Readme: add usage section
1 parent 5b2deba commit 2b96074

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,21 @@ cmake --build . -jNCPUS
8080
* [typed-argument-parser](https://github.com/swansonk14/typed-argument-parser)
8181
* [matplotlib](https://matplotlib.org)
8282

83-
### Notes
83+
### Notes on building
8484

8585
* For developers, add the `-DCMAKE_EXPORT_COMPILE_COMMANDS=1` when working with language servers e.g. clangd.
8686
* To use the Crocoddyl interface, add `-DBUILD_CROCODDYL_COMPAT=ON`
8787
* By default, building the library will instantiate the templates for the `double` scalar type.
8888
* To build against a Conda environment, activate the environment and run `export CMAKE_PREFIX_PATH=$CONDA_PREFIX` before running CMake and use `$CONDA_PREFIX` as your install folder.
8989

90+
## Usage
91+
92+
**aligator** can be used in both C++ (with CMake to create builds) and Python.
93+
94+
Users can refer to [examples](https://github.com/Simple-Robotics/aligator/tree/main/examples) in either language to see how to build a trajectory optimization problem, create a solver instance (with parameters), and solve their problem.
95+
96+
For how to use **aligator** in CMake, including creation of a Python extension module in C++, please refer to the [developer's guide](doc/developers-guide.md).
97+
9098
## Benchmarking
9199

92100
The repo [aligator-bench](https://github.com/Simple-Robotics/aligator-bench) provides a comparison of aligator against other solvers.

0 commit comments

Comments
 (0)