|
1 | | -# Ignition tools |
2 | | - |
3 | | -** Ignition entry point for using all the suite of ignition tools.** |
4 | | - |
5 | | -Ignition tools provide the `ign` command line tool that accepts multiple |
6 | | -subcommands. Each subcommand is implemented in a plugin that belongs to a |
7 | | -specific Ignition project. For example, all the commands that start with |
8 | | -`ign topic ...` will be implemented by the Ignition Transport library. |
9 | | - |
10 | | - [http://ignitionrobotics.org](http://ignitionrobotics.org) |
11 | | - |
12 | | -## Dependencies |
13 | | - |
14 | | -The following dependencies are required to compile ignition-tools from |
15 | | -source: |
16 | | - |
17 | | - - cmake |
18 | | - - git |
19 | | - - ruby-ronn |
20 | | - - ruby-dev |
21 | | - |
22 | | -## Installation |
23 | | - |
24 | | -Standard installation can be performed in UNIX systems using the following |
25 | | -steps: |
26 | | - |
27 | | - - mkdir build/ |
28 | | - - cd build/ |
29 | | - - cmake .. -DCMAKE_INSTALL_PREFIX=/usr |
30 | | - - sudo make install |
31 | | - |
32 | | -## Uninstallation |
33 | | - |
34 | | -To uninstall the software installed with the previous steps: |
35 | | - |
36 | | - - cd build/ |
37 | | - - sudo make uninstall |
| 1 | +# Ignition tools |
| 2 | + |
| 3 | +**Ignition entry point for using all the suite of ignition tools.** |
| 4 | + |
| 5 | +Ignition tools provide the `ign` command line tool that accepts multiple |
| 6 | +subcommands. Each subcommand is implemented in a plugin that belongs to a |
| 7 | +specific Ignition project. For example, all the commands that start with |
| 8 | +`ign topic ...` will be implemented by the Ignition Transport library. |
| 9 | + |
| 10 | +[http://ignitionrobotics.org](http://ignitionrobotics.org) |
| 11 | + |
| 12 | +**Note** While `ign-tools` is currently building on Windows 10, the command line utilities are not yet supported. |
| 13 | + |
| 14 | +# Installation |
| 15 | + |
| 16 | +These instructions are for installing only Ignition Tools. |
| 17 | +If you're interested in using all the Ignition libraries, check out this [Ignition installation](https://ignitionrobotics.org/docs/latest/install). |
| 18 | + |
| 19 | +We recommend following the Binary Installation instructions to get up and running as quickly and painlessly as possible. |
| 20 | + |
| 21 | +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. |
| 22 | + |
| 23 | +Windows support: Currently, the library builds on Windows, but the `ign` command-line tool is not readily functional. We are investigating this. |
| 24 | + |
| 25 | +## Binary Installation |
| 26 | + |
| 27 | +### Ubuntu |
| 28 | + |
| 29 | +On Ubuntu systems, `apt-get` can be used to install `ignition-tools`: |
| 30 | +``` |
| 31 | +sudo apt install libignition-tools<#>-dev |
| 32 | +``` |
| 33 | + |
| 34 | +Be sure to replace `<#>` with a number value, such as 2 or 3, depending on |
| 35 | +which version you need, or leave it empty for version 1. |
| 36 | + |
| 37 | +### Windows |
| 38 | + |
| 39 | +Install [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). |
| 40 | +Miniconda suffices. |
| 41 | + |
| 42 | +Create if necessary, and activate a Conda environment: |
| 43 | +``` |
| 44 | +conda create -n ign-ws |
| 45 | +conda activate ign-ws |
| 46 | +``` |
| 47 | + |
| 48 | +Install `ignition-tools`: |
| 49 | +``` |
| 50 | +conda install libignition-tools<#> --channel conda-forge |
| 51 | +``` |
| 52 | + |
| 53 | +Be sure to replace `<#>` with a number value, such as 2 or 3, depending on |
| 54 | +which version you need, or leave it empty for version 1. |
| 55 | + |
| 56 | +## Source Installation |
| 57 | + |
| 58 | +## UNIX |
| 59 | + |
| 60 | +### Prerequisites |
| 61 | + |
| 62 | +The following dependencies are required to compile ignition-tools from |
| 63 | +source: |
| 64 | + |
| 65 | + - cmake |
| 66 | + - git |
| 67 | + - ruby-ronn |
| 68 | + - ruby-dev |
| 69 | + |
| 70 | +### Build from Source |
| 71 | + |
| 72 | +Standard installation can be performed in UNIX systems using the following |
| 73 | +steps: |
| 74 | +``` |
| 75 | +mkdir build |
| 76 | +cd build |
| 77 | +cmake .. -DCMAKE_INSTALL_PREFIX=/usr |
| 78 | +sudo make install |
| 79 | +``` |
| 80 | + |
| 81 | +### Uninstallation |
| 82 | + |
| 83 | +To uninstall the software installed with the previous steps: |
| 84 | +``` |
| 85 | +cd build |
| 86 | +sudo make uninstall |
| 87 | +``` |
| 88 | + |
| 89 | +## Windows |
| 90 | + |
| 91 | +### Prerequisites |
| 92 | + |
| 93 | +Install [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). |
| 94 | +Miniconda suffices. |
| 95 | + |
| 96 | +Create if necessary, and activate a Conda environment: |
| 97 | +``` |
| 98 | +conda create -n ign-ws |
| 99 | +conda activate ign-ws |
| 100 | +``` |
| 101 | + |
| 102 | +Install prerequisites: |
| 103 | +``` |
| 104 | +conda install ruby git cmake --channel conda-forge |
| 105 | +``` |
| 106 | + |
| 107 | +### Build from Source |
| 108 | + |
| 109 | +This assumes you have created and activated a Conda environment while installing the Prerequisites. |
| 110 | + |
| 111 | +1. Configure and build |
| 112 | + ``` |
| 113 | + mkdir build |
| 114 | + cd build |
| 115 | + cmake .. -DBUILD_TESTING=OFF # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install |
| 116 | + cmake --build . --config Release |
| 117 | + ``` |
| 118 | + |
| 119 | +2. Optionally, install |
| 120 | + ``` |
| 121 | + cmake --install . --config Release |
| 122 | + ``` |
0 commit comments