Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify the README - Move extra details to an "advanced user" section #34

Closed
nunoguedelha opened this issue Apr 14, 2021 · 1 comment
Closed
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@nunoguedelha
Copy link
Collaborator

This is a follow-up of #26 (review).

@traversaro wrote:

The README contains already a lot of documentation that can confuse users that are just interested in using the library. Probably after robotology/robotology-superbuild#576 we could move this "advanced" docs for people that want to modify matlab-whole-body-simulator in separate page, and just leave in the README the easy way of installing it?

@nuno wrote:

Yes absolutely, makes sense. In any case I would say that the steps 1-2-3 listed in the MATLAB Online section stay the same after robotology/robotology-superbuild#576 is integrated. What changes is the content of the installer script. Then, the explanation on the bash limitations, along with the full sections "Installing from superbuild source" and "Installing from Robotology Conda channel" could be moved to the advanced docs as you mentioned.

@nunoguedelha
Copy link
Collaborator Author

Implemented in #49 .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant