Skip to content

Commit ecb1179

Browse files
iox-#1295 Rework installation article
1 parent 1a5b82d commit ecb1179

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

doc/website/getting-started/installation.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ All iceoryx libraries are deployed as independent CMake packages. Posh is using
44

55
## Prerequisites
66

7-
### Dependencies
7+
### :octicons-package-dependencies-16: Dependencies
88

99
- 64-bit hardware (e.g. x86_64 or aarch64; 32-bit hardware works, but only as technology preview and not meant for production)
1010
- [CMake](https://cmake.org), 3.16 or later
@@ -15,7 +15,7 @@ All iceoryx libraries are deployed as independent CMake packages. Posh is using
1515
- [libacl](http://download.savannah.gnu.org/releases/acl/), 2.2 or later. Only for Linux & QNX.
1616
- optional, [ncurses](https://invisible-island.net/ncurses/), 6.2 or later. Required by introspection tool (only for Linux, QNX and MacOS).
1717

18-
### Mac OS
18+
### :material-apple: Mac OS
1919

2020
Before installing iceoryx you need to install XCode and git. Optionally, ncurses library is required for
2121
the introspection client. To install ncurses locally into your build folder follow these steps
@@ -33,7 +33,7 @@ make -j12
3333
make install
3434
```
3535

36-
### Linux
36+
### :fontawesome-brands-linux: Linux
3737

3838
Although we strive to be fully POSIX-compliant, we recommend using Ubuntu 20.04 and at least GCC 8.3 for development.
3939

@@ -52,12 +52,12 @@ sudo apt install libacl1-dev:i386 libc6-dev-i386 libc6-dev-i386-cross libstdc++6
5252

5353
Additionally, there is an optional dependency to the [cpptoml](https://github.com/skystrife/cpptoml) library, which is used to parse the RouDi config file containing mempool configuration.
5454

55-
### QNX
55+
### :fontawesome-brands-blackberry: QNX
5656

5757
QNX SDP 7.1 is supported (shipping with gcc 8.3 respectively).
5858

5959
The easiest way to build iceoryx on QNX is by using the build script and providing a toolchain file.
60-
We provide generic QNX SDP 7.0 toolchain files for ARM_64 and X86_64 in `./tools/toolchains/qnx` ([Direct Link](../../../tools/toolchains/qnx)).
60+
We provide generic QNX SDP 7.0 toolchain files for ARM_64 and X86_64 in `./tools/toolchains/qnx` ([Direct Link](https://github.com/eclipse-iceoryx/iceoryx/tree/v3.0.0/tools/toolchains/qnx)).
6161

6262
ARM_64:
6363

@@ -74,7 +74,7 @@ X86_64:
7474
!!! attention
7575
Please ensure that the folder `/var/lock` exist and the filesystem supports file locking.
7676

77-
### Windows
77+
### :octicons-package-dependencies-16: Windows
7878

7979
In case you do not have a Windows installation, Microsoft provides free developer images from [here](https://developer.microsoft.com/en-us/windows/downloads/virtual-machines/).
8080

@@ -87,7 +87,7 @@ choco install -y cmake --installargs 'ADD_CMAKE_TO_PATH=System'
8787
```
8888
Additional packages can be found [here](https://community.chocolatey.org/packages).
8989

90-
#### Setup for MSVC
90+
#### :material-microsoft-visual-studio: Setup for MSVC
9191

9292
If the developer image from Microsoft is used, Visual Studio Community 2022 is already installed, else it can be found [here](https://visualstudio.microsoft.com/de/downloads/).
9393

@@ -100,7 +100,7 @@ Alternatively, `C:\Program Files (x86)\Microsoft Visual Studio\2022\Community\VC
100100
!!! attention
101101
A Windows SDK Version of at least `10.0.18362.0` is required.
102102

103-
#### Setup for MinGW
103+
#### :simple-mingww64: Setup for MinGW
104104

105105
`MinGW` can also be used to build iceoryx on Windows. The easist way to do this is to use `chocolatey`.
106106

@@ -113,7 +113,7 @@ The `MinGW` library path needs to be added to the `Path` environment variable.
113113
$env:Path += 'C:\ProgramData\chocolatey\lib\mingw\tools\install\mingw64\bin'
114114
```
115115

116-
## Build with CMake
116+
## :material-triangle: Build with CMake
117117

118118
!!! note
119119
Building with CMake is the preferred way, for more complex actions like a coverage scan
@@ -181,10 +181,10 @@ The `CMakeLists.txt` from `iceoryx_meta` can be used to easily develop iceoryx w
181181

182182
### Build options
183183

184-
Please take a look at the CMake file [build_options.cmake](../../../iceoryx_meta/build_options.cmake)
184+
Please take a look at the CMake file [build_options.cmake](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/iceoryx_meta/build_options.cmake)
185185
to get an overview of the available build options for enabling additional features.
186186

187-
## Build with script
187+
## :material-powershell: Build with script
188188

189189
As an alternative, we provide a build-test script which we use to integrate iceoryx into our infrastructure.
190190
The intention of the script goes beyond building iceoryx, it is also used for the code coverage scan or the address-sanitizer runs on the CI.
@@ -215,7 +215,7 @@ You can use the `help` argument for getting an overview of the available options
215215
!!! tip
216216
The examples can be built with `-DEXAMPLES=ON` with iceoryx_meta or by providing the `examples` argument to the build script.
217217

218-
## Build with colcon
218+
## :material-robot: Build with colcon
219219

220220
Alternatively, iceoryx can be built with [colcon](https://colcon.readthedocs.io/en/released/user/installation.html#using-debian-packages) to provide a smooth integration for ROS 2 developers.
221221
To build the iceoryx_integrationtest package one requires a minimal [ROS 2 installation](https://docs.ros.org/en/foxy/Installation/Linux-Install-Debians.html).
@@ -246,7 +246,7 @@ colcon build
246246
247247
This build method makes the most sense in combination with [rmw_iceoryx](https://github.com/ros2/rmw_iceoryx.git)
248248
249-
## Build with Bazel
249+
## :simple-bazel: Build with Bazel
250250
251251
A second option is to build iceoryx with [Bazel](https://bazel.build/) as an alternative build and test tool.
252252
In comparison to CMake it offers an easier syntax with better performance and a hermetic build mode for reproducible builds.

0 commit comments

Comments
 (0)