Skip to content

Commit

Permalink
Consolidate build from source instructions
Browse files Browse the repository at this point in the history
Combine similar steps for Ubuntu and macOS

Signed-off-by: Steve Peters <[email protected]>
  • Loading branch information
scpeters committed Nov 8, 2024
1 parent b9f4d04 commit 592a694
Showing 1 changed file with 33 additions and 39 deletions.
72 changes: 33 additions & 39 deletions tutorials/02_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,10 @@ library and rebuilding dependencies due to the use of c++11. For
purposes of this documentation, assuming OS X 10.9 or greater is in
use. Here are the instructions:

Install homebrew, which should also prompt you to install the XCode
command-line tools:
```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
After installing the [Homebrew package manager](https://brew.sh),
which should also prompt you to install the XCode command-line tools
add OSRF packages and run the install command:

Run the following commands:
```
brew tap osrf/simulation
brew install gz-transport<#>
Expand Down Expand Up @@ -81,7 +78,9 @@ which version you need.

# Source Install

## Ubuntu Linux
## Install Prerequisites

### Ubuntu Linux

For compiling the latest version of Gazebo Transport you will need an
Ubuntu distribution equal to 24.04 (Noble) or newer.
Expand All @@ -97,10 +96,29 @@ Install prerequisites. A clean Ubuntu system will need:
sudo apt-get install git cmake pkg-config python ruby-ronn libprotoc-dev libprotobuf-dev protobuf-compiler uuid-dev libzmq3-dev libgz-msgs11-dev libgz-utils3-cli-dev
```

### macOS

After installing the [Homebrew package manager](https://brew.sh),
which should also prompt you to install the XCode command-line tools
add OSRF packages and run the command to install dependencies:

```
brew tap osrf/simulation
brew install --only-dependencies gz-transport<#>
```

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

## Clone, Configure, and Build

Clone the repository
```
git clone https://github.com/gazebosim/gz-transport
git clone https://github.com/gazebosim/gz-transport -b gz-transport<#>
```
Be sure to replace `<#>` with a number value, such as 10 or 11, depending on
which version you need. From version 12 use `gz-transport<#>` for lower versions
use `ign-transport<#>`

Configure and build
```
Expand All @@ -111,6 +129,13 @@ cmake ..
make
```

Optionally, install
```
sudo make install
```

### Configuration options

Configure Gazebo Transport (choose either method a or b below):

A. Release mode (recommended): This will generate optimized code, but will not have
Expand Down Expand Up @@ -170,37 +195,6 @@ cd /tmp/gz-transport/build
sudo make uninstall
```

### macOS

1. Clone the repository
```
git clone https://github.com/gazebosim/gz-transport -b gz-transport<#>
```
Be sure to replace `<#>` with a number value, such as 10 or 11, depending on
which version you need. From version 12 use `gz-transport<#>` for lower versions
use `ign-transport<#>`

2. Install dependencies
```
brew install --only-dependencies gz-transport<#>
```
Be sure to replace `<#>` with a number value, such as 10 or 11, depending on
which version you need.

3. Configure and build
```
cd gz-transport
mkdir build
cd build
cmake ..
make
```

4. Optionally, install
```
sudo make install
```

## Windows

### Prerequisites
Expand Down

0 comments on commit 592a694

Please sign in to comment.