Skip to content

Commit a2af3b8

Browse files
committed
Improved / Corrected installation description
1 parent 08caee4 commit a2af3b8

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

INSTALL.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,8 @@ The ISAACConfig.cmake searches for these requirements. See
198198
be used. It should be possible to build gStreamer yourself, but it
199199
is strongly adviced - even from the gStreamer team themself - to use
200200
the prebuilt version of your distribution. The HML5 Client can show
201-
streams of a server without gStreamer.
201+
streams of a server without gStreamer. If gStreamer is not found, it is
202+
deactivated by default.
202203
* _Debian/Ubuntu_:
203204
* `sudo apt-get install libgstreamer1.0-dev libgstreamer-plugins-base0.10-dev libgstreamer-plugins-good1.0-dev libgstreamer-plugins-bad1.0-dev`
204205

@@ -235,6 +236,13 @@ isaac (`cd isaac`) do:
235236
* Don't forget the maybe needed `-DLIB_DIR=…` parameters
236237
needed for local installed libraries. E.g.
237238
`cmake -DIceT_DIR=$ICET/install/lib ..`
239+
* There are some options to (de)activate features of the library if they are not needed
240+
or not available on the system (like Cuda), which you can change with
241+
theese lines before `..` (in `cmake ..`) or afterwards with `ccmake` or `cmake-gui`:
242+
* `-DISAAC_CUDA=OFF` → Deactivates CUDA.
243+
* `-DISAAC_ALPAKA=ON` → Activates ALPAKA. The used accelerator of Alpaka can be
244+
changed inside the file `example.cpp`. At default OpenMP version 2 is used as
245+
accelerator. At least CUDA or Alpaka need to be activated.
238246
* `make`
239247

240248
Afterwards you get the executables `example_cuda`, `example_alpaka` or both.
@@ -255,21 +263,13 @@ The server resides in the direcoty `server` and also uses CMake:
255263
* There are some options to (de)activate features of the server if they are not needed
256264
or not available on the system (like Gstreamer), which you can change with
257265
theese lines before `..` (in `cmake ..`) or afterwards with `ccmake` or `cmake-gui`:
258-
* `-DISAAC_GST=OFF` → Deactivates GStreamer.
266+
* `-DISAAC_GST=OFF` → Deactivates GStreamer (Default if not found).
259267
* `-DISAAC_JPEG=OFF` → Deactivates JPEG compression. As already mentioned: This is not advised
260268
and will most probably leave ISAAC in an unusable state in the end.
261269
* `-DISAAC_SDL=ON` → Activates a plugin for showing the oldest not yet finished
262270
visualization in an extra window using `libSDL`. Of course this option does not
263271
make much sense for most servers as they don't have a screen or even an
264272
X server installed.
265-
* `-DISAAC_CUDA=OFF` → Deactivates CUDA.
266-
* `-DISAAC_ALPAKA=ON` → Activates ALPAKA. The used accelerator of Alpaka can be
267-
changed inside the file `example.cpp`. At default OpenMP version 2 is used as
268-
accelerator. At least CUDA or Alpaka need to be activated.
269-
* `-DISAAC_INSTALL_LIBRARY=OFF` → Does not install the library files while installing
270-
the server. This may be wanted if library and server are not used on the same system.
271-
* `-DISAAC_BUILD_SERVER=OFF` → Does not build nor install the server at all. Use this,
272-
if you want to install the library on a system, but not the server itself.
273273
* `make`
274274

275275
If you want to install the server type

0 commit comments

Comments
 (0)