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

Add windows installation; move installation in README to tutorial #122

Closed
wants to merge 2 commits into from
Closed
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
21 changes: 1 addition & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,9 @@ Test coverage:

[![codecov](https://codecov.io/gh/ignitionrobotics/ign-msgs/branch/master/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-msgs)

## Dependencies

Install required dependencies as follows:

sudo apt-get install libprotobuf-dev protobuf-compiler libprotoc-dev libignition-math6-dev

## 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
See the [installation tutorial](https://ignitionrobotics.org/api/msgs/6.2/index.html).

## Test

Expand Down
3 changes: 2 additions & 1 deletion tutorials.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Ignition @IGN_DESIGNATION_CAP@ library and how to use the library effectively.

**The tutorials**

1. \subpage cppgetstarted "C++ Get Started"
1. \subpage install "Installation"
2. \subpage cppgetstarted "C++ Get Started"

## License

Expand Down
91 changes: 91 additions & 0 deletions tutorials/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
\page install Installation

Next Tutorial: \ref cppgetstarted

These instructions are for installing only Ignition Messages.
If you're interested in using all the Ignition libraries, check out this [Ignition installation](https://ignitionrobotics.org/docs/latest/install).

# Dependencies

## UNIX

Install required dependencies as follows:

```
sudo apt-get install libprotobuf-dev protobuf-compiler libprotoc-dev libignition-math6-dev
```

## Windows

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

Choose a reason for hiding this comment

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

Should we point to the tutorial instead?

Copy link
Contributor Author

@mabelzhang mabelzhang Jan 14, 2021

Choose a reason for hiding this comment

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

So... ign-cmake doesn't currently have any tutorials deployed. It was recently added to deploy them, but those pages don't exist yet. I could link to the source of the tutorial, like https://github.com/ignitionrobotics/ign-cmake/blob/ign-cmake2/tutorials/install.md .

Either way, the URL is version-specific, e.g. ign-cmake2, and that means someone will have to update all the tutorials (this wording is the same for each ignition library's tutorial) for each new release. It would also be a different link depending on whether they want ign-cmake2, or ign-cmake3, etc. So I just opted to give the generic link and let them find the right version to look for the tutorial.


Create if necessary, and activate a Conda environment:

```
conda create -n ign-ws
conda activate ign-ws
```

Install prerequisites:

```
conda install tinyxml2 protobuf --channel conda-forge
```

Install Ignition dependencies:

You can view lists of dependencies:

```
conda search libignition-msgs* --channel conda-forge --info
```

Install dependencies, replacing `<#>` with the desired versions:

```
conda install libignition-cmake<#> libignition-math<#> libignition-tools<#> --channel conda-forge
```

# Installation

## UNIX

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

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

## Windows

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

1. Configure and build

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

1. Optionally, install

```
cmake --install . --config Release
```

# Uninstallation

## UNIX

To uninstall the software installed with the previous steps:

```
cd build/
sudo make uninstall
```