Skip to content

Commit

Permalink
update READMEs and CONTRIBUTING files regarding ros2-master
Browse files Browse the repository at this point in the history
  • Loading branch information
SamerKhshiboun committed Jul 1, 2024
1 parent 84d0e1c commit 87522c6
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
* Before opening a new issue, we wanted to provide you with some useful suggestions (Click "Preview" above for a better view):

* Consider checking our ROS RealSense Wrapper documentation [README](https://github.com/IntelRealSense/realsense-ros/blob/ros2-development/README.md).
* Consider checking our ROS RealSense Wrapper documentation [README](https://github.com/IntelRealSense/realsense-ros/blob/ros2-master/README.md).
* Have you looked in our [Discussions](https://github.com/IntelRealSense/realsense-ros/discussions)?
* Try [searching our GitHub Issues](https://github.com/IntelRealSense/realsense-ros/issues) (open and closed) for a similar issue.

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This project welcomes third-party code via GitHub pull requests.
You are welcome to propose and discuss enhancements using project [issues](https://github.com/IntelRealSense/realsense-ros/issues).

> **Branching Policy**:
> The `ros2-development` branch is considered stable, at all times.
> The `ros2-master` branch is considered stable, at all times.
> If you plan to propose a patch, please commit into the `ros2-development` branch, or its own feature branch.
In addition, please run `pr_check.sh` under `scripts` directory. This scripts verify compliance with project's standards:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,15 +58,15 @@

<details>
<summary>
Moving from <a href="https://github.com/IntelRealSense/realsense-ros/tree/ros2-legacy">ros2-legacy</a> to ros2-development
Moving from <a href="https://github.com/IntelRealSense/realsense-ros/tree/ros2-legacy">ros2-legacy</a> to ros2-master
</summary>

* Changed Parameters:
- **"stereo_module"**, **"l500_depth_sensor"** are replaced by **"depth_module"**
- For video streams: **\<module>.profile** replaces **\<stream>_width**, **\<stream>_height**, **\<stream>_fps**
- **ROS2-legacy (Old)**:
- ros2 launch realsense2_camera rs_launch.py depth_width:=640 depth_height:=480 depth_fps:=30.0 infra1_width:=640 infra1_height:=480 infra1_fps:=30.0
- **ROS2-development (New)**:
- **ROS2-master (New)**:
- ros2 launch realsense2_camera rs_launch.py depth_module.profile:=640x480x30
- Removed paramets **\<stream>_frame_id**, **\<stream>_optical_frame_id**. frame_ids are now defined by camera_name
- **"filters"** is removed. All filters (or post-processing blocks) are enabled/disabled using **"\<filter>.enable"**
Expand Down Expand Up @@ -138,7 +138,7 @@

- Clone the latest ROS2 Intel&reg; RealSense&trade; wrapper from [here](https://github.com/IntelRealSense/realsense-ros.git) into '~/ros2_ws/src/'
```bashrc
git clone https://github.com/IntelRealSense/realsense-ros.git -b ros2-development
git clone https://github.com/IntelRealSense/realsense-ros.git -b ros2-master
cd ~/ros2_ws
```

Expand Down
2 changes: 1 addition & 1 deletion realsense2_camera/test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ The xml files mentioned by the command can be directly opened also.
### Running pytests directly

Note :
1. All the commands for test execution has to be executed from realsense-ros folder. For example: If the ROS2 workspace was created based on Step 3 [Option2] of [this](https://github.com/IntelRealSense/realsense-ros/blob/ros2-development/README.md#installation).
1. All the commands for test execution has to be executed from realsense-ros folder. For example: If the ROS2 workspace was created based on Step 3 [Option2] of [this](https://github.com/IntelRealSense/realsense-ros/blob/ros2-master/README.md#installation).
Then, the path to execute the tests would be ~/ros2_ws/src/realsense-ros.

cd ~/ros2_ws/src/realsense-ros
Expand Down

0 comments on commit 87522c6

Please sign in to comment.