Skip to content

Updated README #180

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

Merged
merged 5 commits into from
Apr 23, 2025
Merged

Updated README #180

merged 5 commits into from
Apr 23, 2025

Conversation

larsll
Copy link
Contributor

@larsll larsll commented Mar 22, 2025

Public API Changes
None

Description
This pull request updates the README.md file for the web_video_server project. The changes include a comprehensive reorganization and enhancement of the documentation to provide clearer instructions and additional details about the features, installation, usage, and configuration of the project.

Documentation improvements:

  • Enhanced the project description to clarify the purpose and capabilities of the web_video_server node.
  • Added a detailed "Features" section listing the supported streaming formats and capabilities.
  • Expanded the "Installation" section to include dependencies, package installation instructions for ROS2 distributions, and steps for building from source for both ROS 1 and ROS 2.
  • Introduced a "Usage" section with instructions for starting the server, configuring server parameters, and viewing available streams.
  • Provided detailed instructions and examples for streaming image topics, including URL parameters for customizing the streams and obtaining snapshots.

Copy link
Collaborator

@bjsowa bjsowa left a comment

Choose a reason for hiding this comment

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

Thanks you so much for this and sorry for not reviewing this sooner

larsll and others added 2 commits April 23, 2025 18:39
@larsll
Copy link
Contributor Author

larsll commented Apr 23, 2025

Thanks you so much for this and sorry for not reviewing this sooner

You are welcome. Your suggestions have been applied. Ready to merge I'd say!

@larsll larsll requested a review from bjsowa April 23, 2025 16:40
@bjsowa bjsowa merged commit c17a9b4 into RobotWebTools:ros2 Apr 23, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants