Cleanup README - Githubissues

robotology / icub-models

Official URDF and SDF models of the iCub humanoid robot.

Creative Commons Attribution Share Alike 4.0 International

33 stars 34 forks source link

Cleanup README #226

Closed traversaro closed 11 months ago

traversaro commented 11 months ago

Long delayed cleanup of the README, that is now more clear. Details are provided in the following.

Cleanup installation part:

Document conda installation, that is by far the easiest one
For people interested in apt installation, document that robotology-superbuild is by far the easiest installation when using apt
For users really interested in building the repo from source, move the documentation in a separate file.
Stop documenting the usage of models from the build directory

Cleanup models part:

Document each model installing by the repo, except the one that are in the robots-icebox
Clearly document the package:/ URI required to load each model

Cleanup usage part:

Clearly document how to load the files using YARP, ROS or Gazebo
Document how to load the models using in Python using the resolve-robotics-uri-py package.