Skip to content

Improve README #26

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

Open
Ryanf55 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve README #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,16 @@ For using the template with Gazebo Fortress switch to the `fortress` branch of t
```

### Use as template

Directly `Use this template` and create your project repository on Github.

Or start by creating a workspace and cloning the template repository:
Or start by creating a workspace.
Use VCS to import `ros_gz_project_template` as well as the dependencies that must be built from source.

```bash
mkdir -p ~/template_ws/src
cd ~/template_ws/src
wget https://raw.githubusercontent.com/gazebosim/ros_gz_project_template/main/template_workspace.yaml
vcs import < template_workspace.yaml
cd ~/template_ws
Comment on lines 42 to +43
Copy link
Collaborator

@quarkytale quarkytale Apr 22, 2024

Choose a reason for hiding this comment

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

Instead of ~/ do you think <path_to_workspace> would be more clear?

Copy link
Contributor Author

@Ryanf55 Ryanf55 Apr 22, 2024

Choose a reason for hiding this comment

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

Yes! I don't think we should assume users call it this, or clone in home directory. I certainly don't.

Copy link
Collaborator

@quarkytale quarkytale Apr 22, 2024

Choose a reason for hiding this comment

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

Do you mind making that change, I couldn't make a suggestion over deleted lines

vcs import --input https://raw.githubusercontent.com/gazebosim/ros_gz_project_template/main/template_workspace.yaml src
```

## Usage
Expand All @@ -49,22 +50,22 @@ Or start by creating a workspace and cloning the template repository:

```bash
cd ~/template_ws
source /opt/ros/<ROS_DISTRO>/setup.bash
source /opt/ros/humble/setup.bash
sudo rosdep init
rosdep update
rosdep install --from-paths src --ignore-src -r -i -y --rosdistro <ROS_DISTRO>
rosdep install --from-paths src --ignore-src -i -y
```

1. Build the project

```bash
colcon build --cmake-args -DBUILD_TESTING=ON
colcon build
```

1. Source the workspace

```bash
. ~/template_ws/install/setup.sh
source install/setup.bash
```

1. Launch the simulation
Expand Down