Skip to content

Commit

Permalink
Add Windows installation (#34)
Browse files Browse the repository at this point in the history 
Signed-off-by: Mabel Zhang <[email protected]>

Co-authored-by: John Shepherd <[email protected]>
  • Loading branch information
@mabelzhang
mabelzhang and John Shepherd authored Jan 21, 2021
1 parent 4a87904 commit 07c20cb
Show file tree
Hide file tree
Showing 2 changed files with 207 additions and 105 deletions.
51 changes: 1 addition & 50 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,53 +23,4 @@ of libraries designed to rapidly develop robot applications.

## Installation

Standard installation can be performed in UNIX systems using the following
steps:

mkdir build/
cd build/
cmake ..
sudo make install

## Uninstallation

To uninstall the software installed with the previous steps:

cd build/
sudo make uninstall

## Test

Run tests as follows:

make test

> Tests are automatically built. To disable them, run `cmake` as follows:
cmake .. -DBUILD_TESTING=false

### Test coverage

To run test coverage:

1. Install LCOV

sudo apt-get install lcov

1. Build with coverage

cd build/
cmake .. -DCMAKE_BUILD_TYPE=coverage
make

1. Run tests

make test

1. Generate coverage

make coverage

1. View results

firefox coverage/index.html
See the [installation tutorial](https://ignitionrobotics.org/api/plugin/1.1/installation.html).
261 changes: 206 additions & 55 deletions tutorials/02_installation.md
View file
Original file line number Diff line number Diff line change
@@ -1,105 +1,256 @@
\page installation Installation

This tutorial describes how to install Ignition Plugin on [Ubuntu Linux](#ubuntu_install) and [macOS](#macos_install) via either a binary distribution or from source. Support for Windows is coming soon.
These instructions are for installing only Ignition Plugin.
If you're interested in using all the Ignition libraries, check out this [Ignition installation](https://ignitionrobotics.org/docs/latest/install).

We recommend following the Binary Installation instructions to get up and running as quickly and painlessly as possible.

## Ubuntu ## {#ubuntu_install}
The Source Installation 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.

# Ubuntu

## Prerequisites

Ignition Plugin version 1 requires Ubuntu Bionic, while version 0
can be used with Ubuntu Xenial.

If you don't already have the `lsb-release` package installed, please do so now:
```{.sh}
```
sudo apt-get update
sudo apt-get install lsb-release
```

Setup your computer to accept software from
[packages.osrfoundation.org](http://packages.osrfoundation.org):

```{.sh}
```
sudo sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list'
```

Setup keys:

```{.sh}
```
wget http://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add -
```

Install Ignition Plugin
## Binary Installation

```{.sh}
On Ubuntu systems, `apt-get` can be used to install `ignition-plugin`:
```
sudo apt-get update
sudo apt-get install libignition-plugin-dev
sudo apt install libignition-plugin-dev
```

**Build from source**
## Source Installation

Run the following to install dependencies
```{.sh}
sudo apt-get install libignition-cmake2-dev
```
1. Install Ignition dependencies
```
sudo apt-get install libignition-cmake2-dev
```

Clone the ign-plugin repository from GitHub
```{.sh}
git clone https://github.com/ignitionrobotics/ign-plugin
```
2. Clone the repository
```
git clone https://github.com/ignitionrobotics/ign-plugin
```

Then build using CMake
```{.sh}
cd ign-plugin
mkdir build
cd build
cmake ..
make
sudo make install
```
3. Configure and build
```
cd ign-plugin
mkdir build
cd build
cmake ..
make
```

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

## macOS ## {#macos_install}
# macOS

## Prerequisites

Ignition Plugin and several of its dependencies can be installed on macOS
with [Homebrew](http://brew.sh/) using the [osrf/simulation
tap](https://github.com/osrf/homebrew-simulation). Ignition Plugin version 1
requires macOS High Sierra (10.13) or later, while version 0 supports
Sierra (10.12) or later.

**Install Binaries using Homebrew**
## Binary Installation

Install homebrew, which should also prompt you to install the XCode
command-line tools:
1. Install Homebrew, which should also prompt you to install the XCode command-line tools
```
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```

```{.sh}
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
2. Run the following commands
```
brew tap osrf/simulation
brew install ignition-plugin1
```

## Source Installation

Run the following commands:
1. Install dependencies
```
brew tap osrf/simulation
brew install ignition-plugin1 --only-dependencies
```

```{.sh}
brew tap osrf/simulation
brew install ignition-plugin1
2. Clone the repository
```
git clone https://github.com/ignitionrobotics/ign-plugin
```

3. Configure and build
```
cd ign-plugin
mkdir build
cd build
cmake ..
make
```

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

# Windows

## Prerequisites

First, follow the [ign-cmake](https://github.com/ignitionrobotics/ign-cmake) tutorial for installing Conda, Visual Studio, CMake, and other prerequisites, and also for creating a Conda environment.

Navigate to `condabin` if necessary to use the `conda` command (i.e., if Conda is not in your `PATH` environment variable. You can find the location of `condabin` in Anaconda Prompt, `where conda`).

Create if necessary, and activate a Conda environment:
```
conda create -n ign-ws
conda activate ign-ws
```

**Build from source using Homebrew**
## Binary Installation

Run the following to install dependencies
```{.sh}
brew tap osrf/simulation
brew install ignition-plugin1 --only-dependencies
```
conda install libignition-plugin<#> --channel conda-forge
```

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

## Source Installation

This assumes you have created and activated a Conda environment while installing the Prerequisites.

1. Install Ignition dependencies:

You can view available versions and their dependencies:
```
conda search libignition-plugin* --channel conda-forge --info
```

Clone the ign-plugin repository from GitHub
```{.sh}
git clone https://github.com/ignitionrobotics/ign-plugin
Install dependencies, replacing `<#>` with the desired version:
```
conda install libignition-cmake<#> --channel conda-forge
```

2. Navigate to where you would like to build the library, and clone the repository.
```
# Optionally, append `-b ign-plugin#` (replace # with a number) to check out a specific version
git clone https://github.com/ignitionrobotics/ign-plugin.git
```

3. Configure and build
```
cd ign-plugin
mkdir build
cd build
cmake .. -DBUILD_TESTING=OFF # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install
cmake --build . --config Release
```

4. Optionally, install
```
cmake --install . --config Release
```

# Documentation

API documentation and tutorials can be accessed at
[https://ignitionrobotics.org/libs/plugin](https://ignitionrobotics.org/libs/plugin)

You can also generate the documentation from a clone of this repository by following these steps.

1. You will need [Doxygen](http://www.doxygen.org/). On Ubuntu Doxygen can be installed using
```
sudo apt-get install doxygen
```

2. Clone the repository

```
git clone https://github.com/ignitionrobotics/ign-plugin
```

3. Configure and build the documentation.
```
cd ign-plugin
mkdir build
cd build
cmake ..
make doc
```

4. View the documentation by running the following command from the `build` directory.
```
firefox doxygen/html/index.html
```

**Note** Alternatively, documentation for `ignition-plugin` can be found within the source code, and also in the [MIGRATION.md guide](https://github.com/ignitionrobotics/ign-plugin/blob/master/MIGRATION.md).


# Test

Run tests as follows:
```
make test
```

Then build using CMake
```{.sh}
cd ign-plugin
mkdir build
cd build
cmake ..
make
sudo make install
Tests are automatically built. To disable them, run `cmake` as follows:
```
cmake .. -DBUILD_TESTING=false
```

## Test coverage

To run test coverage:

1. Install LCOV

```
sudo apt-get install lcov
```

2. Build with coverage

```
cd build/
cmake .. -DCMAKE_BUILD_TYPE=coverage
make
```

3. Run tests
```
make test
```

4. Generate coverage
```
make coverage
```

5. View results
```
firefox coverage/index.html
```

0 comments on commit 07c20cb

Please sign in to comment.