Skip to content

Commit

Permalink
Update installation instructions based on feedback (#230)
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Carroll <[email protected]>
  • Loading branch information
mjcarroll authored Sep 14, 2023
1 parent bd0883b commit ca1ce1e
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 16 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ directory.

# Install

See the [installation tutorial](https://gazebosim.org/api/launch/5.0/install.html).
See the [installation tutorial](https://gazebosim.org/api/launch/7/install.html).

# Usage

Expand Down Expand Up @@ -99,7 +99,7 @@ This issue is tracked [here](https://github.com/gazebosim/gz-tools/issues/8).

# Documentation

See the [installation tutorial](https://gazebosim.org/api/launch/5.0/install.html).
See the [installation tutorial](https://gazebosim.org/api/launch/7/install.html).

# Folder Structure

Expand Down
34 changes: 20 additions & 14 deletions tutorials/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Install

These instructions are for installing only Gazebo Launch. If you're interested
in using all the Gazebo libraries, not only Igniton Launch, check out this
in using all the Gazebo libraries, not only Gazebo Launch, check out this
[Gazebo installation](https://gazebosim.org/docs/latest/install).

We recommend following the binary install instructions to get up and running as
Expand All @@ -27,7 +27,7 @@ On Ubuntu systems, `apt` can be used to install `gz-launch`:
sudo apt install libgz-launch<#>
```

Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
Be sure to replace `<#>` with a number value, such as 6 or 7, depending on
which version you need.

## macOS
Expand Down Expand Up @@ -60,7 +60,7 @@ necessary prerequisites followed by building from source.

1. Install third-party libraries:

```
```sh
sudo apt -y install \
$(sort -u $(find . -iname 'packages-'`lsb_release -cs`'.apt' -o -iname 'packages.apt' | grep -v '/\.git/') | sed '/gz\|sdf/d' | tr '\n' ' ')
```
Expand Down Expand Up @@ -97,21 +97,26 @@ necessary prerequisites followed by building from source.
## macOS

1. Clone the repository

```sh
git clone https://github.com/gazebosim/gz-launch -b gz-launch<#>
```
git clone https://github.com/gazebosim/gz-launch -b ign-launch<#>
```

Be sure to replace `<#>` with a number value, such as 4 or 5, depending on
which version you need.

2. Install dependencies
```

```sh
brew install --only-dependencies gz-launch<#>
```

Be sure to replace `<#>` with a number value, such as 5 or 6, depending on
which version you need.

3. Configure and build
```

```sh
cd gz-launch
mkdir build
cd build
Expand All @@ -120,7 +125,8 @@ necessary prerequisites followed by building from source.
```

4. Optionally, install
```

```sh
sudo make install
```

Expand All @@ -132,25 +138,25 @@ You can also generate the documentation from a clone of this repository by follo

1. You will need Doxygen. On Ubuntu Doxygen can be installed using

```
```sh
sudo apt-get install doxygen
```

2. Clone the repository

```
```sh
git clone https://github.com/gazebosim/gz-launch
```

3. Configure and build the documentation.

```
```sh
cd gz-launch; mkdir build; cd build; cmake ../; make doc
```

4. View the documentation by running the following command from the build directory.

```
```sh
firefox doxygen/html/index.html
```

Expand All @@ -162,12 +168,12 @@ Follow these steps to run tests and static code analysis in your clone of this r

2. Run tests.

```
```sh
make test
```

3. Static code checker.

```
```sh
make codecheck
```

0 comments on commit ca1ce1e

Please sign in to comment.