Skip to content

Commit be7e2ed

Browse files
authored
Cleanup README
1 parent 8acbd71 commit be7e2ed

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,25 @@ Repository containing models [automatically](https://github.com/robotology-playg
44

55
The model contained in this repo are licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0) ](https://creativecommons.org/licenses/by-sa/4.0/).
66

7+
## Installation
8+
9+
### conda (recommended)
10+
11+
You can easily install the `icub-models` and the C++ and Python helper libraries via [`conda-forge`](https://conda-forge.org) using the following command
12+
~~~
13+
conda install -c conda-forge idyntree
14+
~~~
15+
16+
If you are not familiar with conda or conda-forge, you can read an introduction document in [conda-forge overview](https://github.com/robotology/robotology-superbuild/blob/master/doc/conda-forge.md#conda-forge-overview).
17+
18+
### robotology-superbuild (advanced)
19+
20+
If you use apt to install your dependencies or if you are install `icub-models` for use as part of [iCub humanoid robot software installation](https://icub-tech-iit.github.io/documentation/sw_installation/), you may want to install icub-models through the [robotology-superbuild](https://github.com/robotology/robotology-superbuild), an easy way to download, compile and install the robotology software on multiple operating systems, using the [CMake](https://www.cmake.org) build system and its extension [YCM](http://robotology.github.io/ycm). `icub-models` is always installed by `robotology-superbuild`.
21+
22+
### Build from source (advanced)
23+
24+
If you want to build icub-models directly from source of from the repo, you can check the documentation in [`doc/build-from-source.md`](doc/build-from-source.md).
25+
726
## Usage
827

928
The model in the repo can be used either directly from the repo, or by installing them.

0 commit comments

Comments
 (0)