Improve installation and testing documentation in README #140
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@saikishor can you review this? |
saikishor
reviewed
Mar 22, 2025
README.md
Outdated
| * Visual servoing: track object and hand at the same time | ||
| ### Prerequisites | ||
| - A compatible Ubuntu version for your chosen ROS distribution | ||
| - ROS installed (ROS 1 or ROS 2) |
There was a problem hiding this comment.
Could you mention the OpenCV versions as well?
README.md
Outdated
Comment on lines
29
to
72
| ### 2. Creating a ROS Workspace | ||
|
|
||
| ```bash | ||
| # Create a workspace folder | ||
| mkdir -p ~/aruco_ws/src | ||
| cd ~/aruco_ws/src | ||
| ``` | ||
|
|
||
| ### 3. Clone the aruco_ros Repository | ||
|
|
||
| ```bash | ||
| # Clone the repository | ||
| git clone https://github.com/pal-robotics/aruco_ros.git -b <distro>-devel | ||
| ``` | ||
| Replace `<distro>` with your ROS distribution name (e.g., melodic, noetic, humble) | ||
|
|
||
| ### 4. Install Dependencies | ||
|
|
||
| ```bash | ||
| # Navigate to the workspace root | ||
| cd ~/aruco_ws | ||
| # Install dependencies using rosdep | ||
| rosdep install --from-paths src --ignore-src -r -y | ||
| ``` | ||
|
|
||
| ### 5. Build the Workspace | ||
|
|
||
| For ROS 1: | ||
| ```bash | ||
| # Build the workspace using catkin_make | ||
| cd ~/aruco_ws | ||
| catkin_make | ||
| # Source the setup file to update environment | ||
| source devel/setup.bash | ||
| ``` | ||
|
|
||
| For ROS 2: | ||
| ```bash | ||
| # Build the workspace using colcon | ||
| cd ~/aruco_ws | ||
| colcon build | ||
| # Source the setup file to update environment | ||
| source install/setup.bash | ||
| ``` |
There was a problem hiding this comment.
All of this, I would set under a section Build from Source
And it would be great, if you can add a section "Using Binaries"
README.md
Outdated
Comment on lines
74
to
102
| ### 6. Installing REEM Robot Simulation (Optional) | ||
|
|
||
| If you want to test with the REEM robot as in the examples below, you'll need to install the REEM robot packages from source: | ||
|
|
||
| ```bash | ||
| # Create a workspace for REEM if you don't want to use your existing one | ||
| mkdir -p ~/reem_ws/src | ||
| cd ~/reem_ws/src | ||
|
|
||
| # Clone the necessary repositories | ||
| git clone https://github.com/pal-robotics/reem_robot.git | ||
| git clone https://github.com/pal-robotics/reem_simulation.git | ||
| git clone https://github.com/pal-robotics/pal_gazebo_worlds.git -b <distro>-devel | ||
|
|
||
| # Install dependencies | ||
| cd ~/reem_ws | ||
| rosdep install --from-paths src --ignore-src -r -y | ||
|
|
||
| # Build the workspace | ||
| # For ROS 1: | ||
| catkin_make | ||
| source devel/setup.bash | ||
|
|
||
| # For ROS 2: | ||
| colcon build | ||
| source install/setup.bash | ||
| ``` | ||
|
|
||
| Replace `<distro>` with your ROS distribution name (e.g., noetic, humble) |
|
@saikishor I've made all the requested changes to the README:
Could you please verify these changes? Let me know if anything else needs adjustment. |
|
@saikishor Did you get a chance to review this? If everything looks good, could you please close the PR? Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR enhances the README.md documentation for the aruco_ros repository by adding comprehensive installation and setup instructions while preserving all existing content. These improvements aim to lower the barrier to entry for new users and make the repository more accessible.
Changes Made
Benefits
Testing Done
I've verified that these installation instructions work properly on Ubuntu 20.04 with ROS Noetic and Ubuntu 22.04 with ROS Humble. All commands and paths have been carefully checked for accuracy.
Motivation
I'm interested in contributing to this project as part of my GSoC application. After reviewing the repository, I identified documentation as an area where I could make an immediate positive impact while familiarizing myself with the codebase.
I look forward to any feedback and am happy to make additional changes as needed.