Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: add Quick Start Example to READMEAdded quick start example #940

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
Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: add Quick Start Example to READMEAdded quick start example #940

wants to merge 1 commit into from

Conversation

FeliciaSeq
Copy link

This PR adds a Quick Start Example to the README, showing how to connect to a ROS master, handle connection events, and publish to a topic using roslibjs.

The goal is to help new developers quickly get started without needing to dig into examples or external docs.

MatthijsBurgh
MatthijsBurgh requested changes Sep 22, 2025
View reviewed changes
Copy link
Contributor

@MatthijsBurgh MatthijsBurgh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is good to point out the examples folder in the README. Though adding the code here, which is exactly the same code as in the simple node example, requires it to be maintained. Which I don't like.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MatthijsBurgh MatthijsBurgh MatthijsBurgh requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@FeliciaSeq @MatthijsBurgh