Skip to content
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.

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

Removed repeated installation instructions #95

Merged
merged 5 commits into from
Aug 27, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
69 changes: 1 addition & 68 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,6 @@ designed to support simulation and rapid development of robot applications.

[Install](#install)

* [Binary Install](#binary-install)

* [Source Install](#source-install)

* [Prerequisites](#prerequisites)

* [Building from Source](#building-from-source)

[Usage](#usage)

[Documentation](#documentation)
Expand Down Expand Up @@ -80,66 +72,7 @@ Ignition Physics provides the following functionality:

# Install

We recommend following the [Binary Install](#binary-install) instructions to get up and running as quickly and painlessly as possible.

The [Source Install](#source-install) instructions should be used if you need the very latest software improvements, you need to modify the code, or you plan to make a contribution.

## Binary Install

On Ubuntu systems, `apt-get` can be used to install `ignition-physics3`:

```
sudo apt install libignition-physics3-dev
```

## Source Install

Source installation can be performed in UNIX systems by first installing the
necessary prerequisites followed by building from source.

### Prerequisites

Install required dependencies:

~~~
sudo apt update
sudo apt-get -y install lsb-release
sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list'
apt-key adv --keyserver keyserver.ubuntu.com --recv-keys D2486D2DD83DB69272AFE98867170598AF249743
sudo apt-add-repository -s "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -c -s) main"
sudo apt-get build-dep -y ignition-physics3
~~~

Use gcc-8:

~~~
sudo apt update
sudo apt-get -y install g++-8
sudo update-alternatives --install \
/usr/bin/gcc gcc /usr/bin/gcc-8 800 \
--slave /usr/bin/g++ g++ /usr/bin/g++-8 \
--slave /usr/bin/gcov gcov /usr/bin/gcov-8
~~~

### Building from source

1. Clone the repository

```
git clone https://github.com/ignitionrobotics/ign-physics -b master
```

2. Configure and build

```
cd ign-physics; mkdir build; cd build; cmake ..; make
```

3. Optionally, install Ignition Physics

```
sudo make install
```
See the [installation tutorial](https://ignitionrobotics.org/api/physics/2.2/installation.html).

# Usage

Expand Down
70 changes: 48 additions & 22 deletions tutorials/02_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,31 +31,52 @@ wget http://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add -

```{.sh}
sudo apt-get update
sudo apt-get install libignition-physics3-dev
sudo apt-get install libignition-physics<#>-dev
```

chapulina marked this conversation as resolved.
Show resolved Hide resolved
Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need.

**Build from source**

Run the following to install dependencies
```{.sh}
sudo apt-add-repository -s "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -c -s) main"
sudo apt-get build-dep -y ignition-physics3
```
1. Run the following to install dependencies

Clone the ign-physics repository from GitHub
```{.sh}
git clone https://github.com/ignitionrobotics/ign-physics -b master
```
```{.sh}
sudo apt-add-repository -s "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -c -s) main"
sudo apt-get build-dep -y ignition-physics<#>-dev
```
Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need.


2. Use gcc-8:

```
sudo apt update
sudo apt-get -y install g++-8
sudo update-alternatives --install \
/usr/bin/gcc gcc /usr/bin/gcc-8 800 \
--slave /usr/bin/g++ g++ /usr/bin/g++-8 \
--slave /usr/bin/gcov gcov /usr/bin/gcov-8
```

3. Clone the repository

```
git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics<#>
```
Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need.

Then build using CMake
```{.sh}
cd ign-physics
mkdir build
cd build
cmake ..
make
sudo make install
```

4. Configure and build

```
cd ign-physics; mkdir build; cd build; cmake ..; make
```

5. Optionally, install Ignition Physics

```
sudo make install
```

## macOS

Expand All @@ -79,21 +100,26 @@ Run the following commands:

```{.sh}
brew tap osrf/simulation
brew install ignition-physics3
brew install ignition-physics<#>
```
Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need.


**Build from source using Homebrew**

Run the following to install dependencies
```{.sh}
brew tap osrf/simulation
brew install ignition-physics3 --only-dependencies
brew install ignition-physics<#> --only-dependencies
```

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

Clone the ign-physics repository from GitHub
```{.sh}
git clone https://github.com/ignitionrobotics/ign-physics -b master
git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics<#>
```
Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need.

Then build using CMake
```{.sh}
Expand Down