From 697459f79188c2c856478f241b0e8645aa2d85d2 Mon Sep 17 00:00:00 2001 From: Mabel Zhang Date: Thu, 24 Dec 2020 00:10:28 -0500 Subject: [PATCH 1/7] 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 89a18f1f..9af2d4e8 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 121562767c7495a2794d8c57b94afe4f63f9b1f0 Mon Sep 17 00:00:00 2001 From: Mabel Zhang Date: Thu, 24 Dec 2020 12:00:34 -0500 Subject: [PATCH 2/7] 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 From c59d7d899e80ce238eef9b9435a4d2a0bf27eefc Mon Sep 17 00:00:00 2001 From: Mabel Zhang Date: Thu, 14 Jan 2021 01:39:36 -0500 Subject: [PATCH 3/7] standardize to ign-common template Signed-off-by: Mabel Zhang --- tutorials/install.md | 113 ++++++++++++++++++++++++++++--------------- 1 file changed, 75 insertions(+), 38 deletions(-) diff --git a/tutorials/install.md b/tutorials/install.md index 0efb624b..a4aa810b 100644 --- a/tutorials/install.md +++ b/tutorials/install.md @@ -5,54 +5,59 @@ 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 +We recommend following the Binary Install instructions to get up and running as quickly and painlessly as possible. -## UNIX +The 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. -Install required dependencies as follows: +# Binary Install + +## Ubuntu +On Ubuntu systems, `apt-get` can be used to install `ignition-msgs`: ``` -sudo apt-get install libprotobuf-dev protobuf-compiler libprotoc-dev libignition-math6-dev +sudo apt install libignition-msgs<#>-dev ``` +Be sure to replace `<#>` with a number value, such as 2 or 3, depending on +which version you need. + ## 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. +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: - +Install `ignition-msgs`: ``` -conda install tinyxml2 protobuf --channel conda-forge +conda install libignition-msgs<#> --channel conda-forge ``` -Install Ignition dependencies: +Be sure to replace `<#>` with a number value, such as 2 or 3, depending on +which version you need. -You can view lists of dependencies: +# Source Install -``` -conda search libignition-msgs* --channel conda-forge --info -``` +Source installation can be performed by first installing the necessary +prerequisites followed by building from source. -Install dependencies, replacing `<#>` with the desired versions: +## Ubuntu +### Prerequisites + +Install required dependencies as follows: ``` -conda install libignition-cmake<#> libignition-math<#> libignition-tools<#> --channel conda-forge +sudo apt-get install libprotobuf-dev protobuf-compiler libprotoc-dev libignition-math6-dev ``` -# Installation - -## UNIX +### Building from Source Standard installation can be performed in UNIX systems using the following steps: - ``` mkdir build/ cd build/ @@ -60,32 +65,64 @@ cmake .. sudo make install ``` -## Windows +### Uninstallation -This assumes you have created and activated a Conda environment while installing the Dependencies. +To uninstall the software installed with the previous steps: +``` +cd build/ +sudo make uninstall +``` -1. Configure and build +## Windows - ``` - mkdir build - cd build - cmake .. -DBUILD_TESTING=OFF # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install - cmake --build . --config Release - ``` +### Prerequisites -1. Optionally, install +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. - ``` - cmake --install . --config Release - ``` +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`). -# Uninstallation +Activate the Conda environment: +``` +conda activate ign-ws +``` -## UNIX +Install prerequisites: +``` +conda install tinyxml2 protobuf --channel conda-forge +``` -To uninstall the software installed with the previous steps: +Install Ignition dependencies: +You can view lists of dependencies: ``` -cd build/ -sudo make uninstall +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 +``` + +### Building from Source + +This assumes you have created and activated a Conda environment while installing the Dependencies. + +1. Navigate to where you would like to build the library, and clone the repository. + ``` + # Optionally, append `-b ign-msgs#` (replace # with a number) to check out a specific version + git clone https://github.com/ignitionrobotics/ign-msgs.git + ``` + +2. Configure and build + ``` + cd ign-msgs + mkdir build + cd build + cmake .. -DBUILD_TESTING=OFF # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install + cmake --build . --config Release + ``` + +3. Optionally, install + ``` + cmake --install . --config Release + ``` From 9fb55206070831139c4f100a70387066992aef45 Mon Sep 17 00:00:00 2001 From: Mabel Zhang Date: Thu, 14 Jan 2021 03:30:45 -0500 Subject: [PATCH 4/7] nits Signed-off-by: Mabel Zhang --- tutorials/install.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/tutorials/install.md b/tutorials/install.md index a4aa810b..f3e318b4 100644 --- a/tutorials/install.md +++ b/tutorials/install.md @@ -5,11 +5,11 @@ 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). -We recommend following the Binary Install instructions to get up and running as quickly and painlessly as possible. +We recommend following the Binary Installation instructions to get up and running as quickly and painlessly as possible. -The 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. +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. -# Binary Install +# Binary Installation ## Ubuntu @@ -40,7 +40,7 @@ conda install libignition-msgs<#> --channel conda-forge Be sure to replace `<#>` with a number value, such as 2 or 3, depending on which version you need. -# Source Install +# Source Installation Source installation can be performed by first installing the necessary prerequisites followed by building from source. @@ -105,7 +105,7 @@ conda install libignition-cmake<#> libignition-math<#> libignition-tools<#> --ch ### Building from Source -This assumes you have created and activated a Conda environment while installing the Dependencies. +This assumes you have created and activated a Conda environment while installing the Prerequisites. 1. Navigate to where you would like to build the library, and clone the repository. ``` From c1b2cfda6f7fda2750a50ee9ba8d01fc2ed372b0 Mon Sep 17 00:00:00 2001 From: John Shepherd Date: Tue, 19 Jan 2021 22:40:15 -0800 Subject: [PATCH 5/7] nit Signed-off-by: John Shepherd --- tutorials/install.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/tutorials/install.md b/tutorials/install.md index f3e318b4..2dc6af22 100644 --- a/tutorials/install.md +++ b/tutorials/install.md @@ -42,9 +42,6 @@ which version you need. # Source Installation -Source installation can be performed by first installing the necessary -prerequisites followed by building from source. - ## Ubuntu ### Prerequisites From 0673e1fcc51f24c82cc429fa8b780846e4eb4367 Mon Sep 17 00:00:00 2001 From: John Shepherd Date: Wed, 20 Jan 2021 12:54:40 -0800 Subject: [PATCH 6/7] move docs and testing to install Signed-off-by: John Shepherd --- README.md | 59 -------------------------------- tutorials/install.md | 81 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 81 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 9af2d4e8..c4172158 100644 --- a/README.md +++ b/README.md @@ -15,65 +15,6 @@ Test coverage: See the [installation tutorial](https://ignitionrobotics.org/api/msgs/6.2/index.html). -## Test - -Run tests as follows: - - make test - -Tests are automatically built. To disable them, run `cmake` as follows: - - cmake .. -DENABLE_TESTS_COMPILATION=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 - -## Create Documentation & Release - -1. Build documentation - -``` -cd build -make doc -``` - -1. Upload documentation to ignitionrobotics.org. - -``` -cd build -sh upload.sh -``` - -1. If you're creating a new release, then tell ignitionrobotics.org about - the new version. For example: - -``` -curl -k -X POST -d '{"libName":"msgs", "version":"1.0.0", "releaseDate":"2017-10-09T12:10:13+02:00","password":"secret"}' https://api.ignitionrobotics.org/1.0/versions -``` - ## Known issue of command line tools In the event that the installation is a mix of Debian and from source, command diff --git a/tutorials/install.md b/tutorials/install.md index 2dc6af22..7ea67d4f 100644 --- a/tutorials/install.md +++ b/tutorials/install.md @@ -123,3 +123,84 @@ This assumes you have created and activated a Conda environment while installing ``` cmake --install . --config Release ``` + +# Documentation + +API documentation and tutorials can be accessed at +[https://ignitionrobotics.org/libs/cmake](https://ignitionrobotics.org/libs/cmake) + +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-cmake + +3. Configure and build the documentation. + + cd ign-cmake + 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 + +## Documentation Release + +1. Upload documentation to ignitionrobotics.org. + +``` +cd build +sh upload.sh +``` + +2. If you're creating a new release, then tell ignitionrobotics.org about + the new version. For example: + +``` +curl -k -X POST -d '{"libName":"msgs", "version":"1.0.0", "releaseDate":"2017-10-09T12:10:13+02:00","password":"secret"}' https://api .ignitionrobotics.org/1.0/versions +``` + +## Testing + +Run tests as follows: + + make test + +Tests are automatically built. To disable them, run `cmake` as follows: + + cmake .. -DENABLE_TESTS_COMPILATION=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 + +See the [Writing Tests section of the Ignition documentation](https://ignitionrobotics.org/docs/all/contributing#writing-tests) for help creating or modifying tests. From d7b6d6b67514a44f486e8a3f2766ca71c83e13cf Mon Sep 17 00:00:00 2001 From: John Shepherd Date: Wed, 20 Jan 2021 13:19:22 -0800 Subject: [PATCH 7/7] spacing nit Signed-off-by: John Shepherd --- tutorials/install.md | 53 ++++++++++++++++++++++++++------------------ 1 file changed, 31 insertions(+), 22 deletions(-) diff --git a/tutorials/install.md b/tutorials/install.md index 7ea67d4f..949ac74b 100644 --- a/tutorials/install.md +++ b/tutorials/install.md @@ -132,75 +132,84 @@ API documentation and tutorials can be accessed at 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-cmake + ``` 3. Configure and build the documentation. - + ``` cd ign-cmake 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 + ``` ## Documentation Release 1. Upload documentation to ignitionrobotics.org. - -``` -cd build -sh upload.sh -``` + ``` + cd build + sh upload.sh + ``` 2. If you're creating a new release, then tell ignitionrobotics.org about the new version. For example: - -``` -curl -k -X POST -d '{"libName":"msgs", "version":"1.0.0", "releaseDate":"2017-10-09T12:10:13+02:00","password":"secret"}' https://api .ignitionrobotics.org/1.0/versions -``` + ``` + curl -k -X POST -d '{"libName":"msgs", "version":"1.0.0", "releaseDate":"2017-10-09T12:10:13+02:00","password":"secret"}' https://api .ignitionrobotics.org/1.0/versions + ``` ## Testing Run tests as follows: - - make test + ``` + make test + ``` Tests are automatically built. To disable them, run `cmake` as follows: - - cmake .. -DENABLE_TESTS_COMPILATION=false + ``` + cmake .. -DENABLE_TESTS_COMPILATION=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 + ``` See the [Writing Tests section of the Ignition documentation](https://ignitionrobotics.org/docs/all/contributing#writing-tests) for help creating or modifying tests.