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.

Sign up for GitHub

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

Jump to bottom

Enhancing README.md #383

Closed
Nils-ChristianIseke opened this issue Dec 5, 2023 · 3 comments
Closed

Enhancing README.md #383

Nils-ChristianIseke opened this issue Dec 5, 2023 · 3 comments
Labels
enhancement New feature or request

Comments

@Nils-ChristianIseke
Copy link
Contributor

The README.md file does not provide enough support for inexperienced users. This causes unnecessary issues / work for / by inexperienced users.
The README should at least refer to the necessary resources, better still have a step by step guide on how to run the examples from scratch.
@Nils-ChristianIseke Nils-ChristianIseke added the enhancement New feature or request label Dec 5, 2023
@christophfroehlich
Copy link
Contributor

The necessary information is inside the doc folder in rst syntax for https://control.ros.org/master/doc/ros2_control_demos/doc/index.html
I don't want to duplicate information actually.

But I see that there is a lack of an introduction in the readme.md pointing to the correct page on control.ros.org. Would this be sufficient?

@Nils-ChristianIseke
Copy link
Contributor Author

How about #384?

@christophfroehlich
Copy link
Contributor

closed with #384

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@christophfroehlich @Nils-ChristianIseke