Skip to content

Commit

Permalink
Removed repeated installation instructions (#147)
Browse files Browse the repository at this point in the history
Signed-off-by: ahcorde <[email protected]>
Signed-off-by: Louise Poubel <[email protected]>
Co-authored-by: Louise Poubel <[email protected]>
  • Loading branch information
ahcorde and chapulina authored Aug 22, 2020
1 parent 1c8331c commit 6a3c4a3
Show file tree
Hide file tree
Showing 2 changed files with 87 additions and 72 deletions.
80 changes: 12 additions & 68 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,33 +20,25 @@ classes and functions designed for robotic applications.

# Table of Contents

[Features](#markdown-header-features)
[Features](#features)

[Install](#markdown-header-install)
[Install](#install)

* [Binary Install](#markdown-header-binary-install)
[Usage](#usage)

* [Source Install](#markdown-header-source-install)
[Documentation](#documentation)

* [Prerequisites](#markdown-header-prerequisites)
[Testing](#testing)

* [Building from Source](#markdown-header-building-from-source)
[Folder Structure](#folder-structure)

[Usage](#markdown-header-usage)
[Code of Conduct](#code-of-conduct)

[Documentation](#markdown-header-documentation)
[Contributing](#code-of-contributing)

[Testing](#markdown-header-testing)
[Versioning](#versioning)

[Folder Structure](#markdown-header-folder-structure)

[Code of Conduct](#markdown-header-code-of-conduct)

[Contributing](#markdown-header-code-of-contributing)

[Versioning](#markdown-header-versioning)

[License](#markdown-header-license)
[License](#license)

# Features

Expand All @@ -60,55 +52,7 @@ Math types.

# Install

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

The [Source Install](#markdown-header-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-math`:

```
sudo apt install libignition-math<#>-dev
```

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

## Source Install

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

### Prerequisites

The optional Eigen component of Ignition Math requires:

* [Eigen](http://eigen.tuxfamily.org/index.php?title=Main_Page). Refer to the [Eigen Documentation](http://eigen.tuxfamily.org/index.php?title=Main_Page#Documentation) for installation instructions. On Ubuntu systems, `apt-get` can be used to install Eigen:

```
sudo apt-get install libeigen3-dev
```
### Building from source
1. Clone the repository
```
git clone https://github.com/ignitionrobotics/ign-math
```
2. Configure and build
```
cd ign-math; mkdir build; cd build; cmake ..; make
```
3. Optionally, install Ignition Math
```
sudo make install
```
See the [installation tutorial](https://ignitionrobotics.org/api/math/6.4/install.html).

# Usage

Expand Down Expand Up @@ -148,7 +92,7 @@ You can also generate the documentation from a clone of this repository by follo
Follow these steps to run tests and static code analysis in your clone of this repository.
1. Follow the [source install instruction](#markdown-header-source-install).
1. Follow the [source install instruction](https://ignitionrobotics.org/libs/math#source-install).
2. Run tests.
Expand Down
79 changes: 75 additions & 4 deletions tutorials/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,30 @@

Next Tutorial: \ref cppgetstarted

## Overview
# Overview

This tutorial describes how to install Ignition Math on Linux, Mac OS X and
Windows via either a binary distribution or from source.

## Ubuntu Linux
[Install](#install)

* [Binary Install](#binary-install)

* [Source Install](#source-install)

* [Prerequisites](#prerequisites)

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

# 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

### Ubuntu Linux

Setup your computer to accept software from
*packages.osrfoundation.org*:
Expand All @@ -25,6 +43,59 @@ wget http://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add -
Install Ignition Math:

```
sudo apt-get update
sudo apt-get install libignition-math7-dev
sudo apt install libignition-math<#>-dev
```

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

## Source Install

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

### Prerequisites

The optional Eigen component of Ignition Math requires:

* [Eigen](http://eigen.tuxfamily.org/index.php?title=Main_Page). Refer to the [Eigen Documentation](http://eigen.tuxfamily.org/index.php?title=Main_Page#Documentation) for installation instructions. On Ubuntu systems, `apt-get` can be used to install Eigen:

```
sudo apt-get install libeigen3-dev
```
The optional Ruby tests of Ignition Math require:
* [Ruby](https://www.ruby-lang.org/). Refer to the [Ruby Documentation](https://www.ruby-lang.org/downloads/) for installation instructions. On Ubuntu systems `apt-get` can be used to install Ubuntu Package `ruby-dev`:
```
sudo apt-get install ruby-dev
```
* [Swig](http://www.swig.org/). Refer to the [Swig Documentation](http://www.swig.org/download.html) for installation instructions. On Ubuntu systems `apt-get` can be used to install Swig:
```
sudo apt-get install swig
```
### Building from source
1. Clone the repository
```
git clone https://github.com/ignitionrobotics/ign-math -b ign-math<#>
```
Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
which version you need.
2. Configure and build
```
cd ign-math; mkdir build; cd build; cmake ..; make
```
3. Optionally, install Ignition Math
```
sudo make install
```

0 comments on commit 6a3c4a3

Please sign in to comment.