From 327d171bad4c247591dc3e504f236bb0fa9e5112 Mon Sep 17 00:00:00 2001 From: Mabel Zhang Date: Thu, 24 Dec 2020 00:10:28 -0500 Subject: [PATCH 1/2] add windows installation Signed-off-by: Mabel Zhang --- README.md | 21 +----------- tutorials.md.in | 3 +- tutorials/install.md | 78 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 81 insertions(+), 21 deletions(-) create mode 100644 tutorials/install.md diff --git a/README.md b/README.md index c3326f78..df041385 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/tutorials.md.in b/tutorials.md.in index 1c537a43..c8608b49 100644 --- a/tutorials.md.in +++ b/tutorials.md.in @@ -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 diff --git a/tutorials/install.md b/tutorials/install.md new file mode 100644 index 00000000..efb75a4f --- /dev/null +++ b/tutorials/install.md @@ -0,0 +1,78 @@ +\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 + +Install [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). +Miniconda suffices. + +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 +``` + +# 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 +``` From bde8e44973b66cc85177f657c28ef14507f59992 Mon Sep 17 00:00:00 2001 From: Mabel Zhang Date: Thu, 24 Dec 2020 12:00:34 -0500 Subject: [PATCH 2/2] tweaks Signed-off-by: Mabel Zhang --- tutorials/install.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/tutorials/install.md b/tutorials/install.md index efb75a4f..0efb624b 100644 --- a/tutorials/install.md +++ b/tutorials/install.md @@ -17,8 +17,7 @@ sudo apt-get install libprotobuf-dev protobuf-compiler libprotoc-dev libignition ## Windows -Install [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). -Miniconda suffices. +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. Create if necessary, and activate a Conda environment: @@ -33,6 +32,20 @@ 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