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.

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

Removed repeated installation instructions #95

Merged
merged 5 commits into from
Aug 27, 2020
Merged

Removed repeated installation instructions #95

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4886316
Removed repeated installation instructions
ahcorde Aug 13, 2020
34218d2
Updated install link
ahcorde Aug 14, 2020
697a7be
Improved install instructions
ahcorde Aug 17, 2020
a13b5d0
Merge remote-tracking branch 'origin/master' into ahcorde/docs/instal…
ahcorde Aug 24, 2020
c8b3699
Fixed instructions
ahcorde Aug 25, 2020
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
View file
Open in desktop
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
```
Review the [tutorial section](https://ignitionrobotics.org/api/physics/2.2/installation.html).

# Usage

Expand Down
51 changes: 33 additions & 18 deletions tutorials/02_installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,41 @@ sudo apt-get install libignition-physics3-dev

chapulina marked this conversation as resolved.
Show resolved Hide resolved
**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-physics3
Copy link
Contributor

Choose a reason for hiding this comment

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

This won't work yet, because ignition-physics3 hasn't been released.

We could instruct users to get dependencies from these packages files once #94 is merged:

https://github.com/ignitionrobotics/ign-physics/tree/ign-physics2/.github/ci

```

Then build using CMake
```{.sh}
cd ign-physics
mkdir build
cd build
cmake ..
make
sudo make install
```
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 master
```

4. Configure and build

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

5. Optionally, install Ignition Physics

```
sudo make install
```

## macOS

Expand Down