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

Document how to use each plugin #146

Open
xela-95 opened this issue Apr 5, 2024 · 2 comments
Open

Document how to use each plugin #146

xela-95 opened this issue Apr 5, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation phase:state-of-art

Comments

@xela-95
Copy link
Member

xela-95 commented Apr 5, 2024

To facilitate the adoption of of gz-sim-yarp-plugins is useful to provide documentation on how to use and configure the plugins.

Hence, we want to add to each of them a brief README page documenting:

  • how to add the plugin in a model;
  • how to configure the plugin via yarpConfigurationString or yarpConfigurationFile, explaining what the required and optional parameters are;
  • refer to the tutorials using it;
@traversaro
Copy link
Member

In #232 I add a README for the new gzyarp::ConfigurationOverride plugin, I think we can use it as an example of the README.md to add to each plugin folder.

@xela-95
Copy link
Member Author

xela-95 commented Feb 7, 2025

Yes that is perfect to me! I will try to add the README for the other as soon as I have time!

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 phase:state-of-art
Projects
None yet
Development

No branches or pull requests

2 participants