Merge branch 'main' into remove-obsolete-changelog-files

INSTALL.md

@@ -1,74 +1,76 @@
-INSTALLATION INSTRUCTIONS FOR GVM-LIBS
-======================================
+# Installation Instructions for gvm-libs
 
 Please note: The reference system used by most of the developers is Debian
-GNU/Linux 'Bullseye' 11. The build might fail on any other system. Also, it is
-necessary to install dependent development packages.
+stable. The build might fail on any other system. Also, it is necessary to
+install dependent development packages.
 
-Prerequisites for gvm-libs
---------------------------
+## Prerequisites for gvm-libs
 
 See at the end of this section how to easily install these prerequisites on
 some supported platforms.
 
 General build environment:
+
 * a C compiler (e.g. gcc)
 * cmake >= 3.0
 * pkg-config
 
 Specific development libraries:
+
 * libcjson >= 1.7.14 (util)
 * libcurl >= 7.83.0 (openvasd)
-* libglib >= 2.42 (all)
+* libgcrypt
 * libgio >= 2.42 (util)
-* zlib >= 1.2.8 (util)
-* libgpgme >= 1.7.0 (util)
+* libglib >= 2.42 (all)
 * libgnutls >= 3.2.15 (util)
-* libuuid >= 2.25.0 (util)
-* libssh >= 0.6.0 (util)
+* libgpgme >= 1.7.0 (util)
 * libhiredis >= 0.10.1 (util)
-* libxml2 >= 2.0 (util)
 * libnet1 >= 1.1.2.1 (boreas)
-* libpcap
-* libgcrypt
 * libpaho-mqtt >= 1.3.0 (utils)
+* libpcap
+* libssh >= 0.6.0 (util)
+* libuuid >= 2.25.0 (util)
+* libxml2 >= 2.0 (util)
+* zlib >= 1.2.8 (util)
 
 Prerequisites for building documentation:
+
 * doxygen
 * xmltoman (optional, for building man page)
 
 Prerequisites for building tests:
+
 * [Cgreen](https://cgreen-devs.github.io/cgreen/cgreen-guide-en.html#_installing_cgreen) (optional, for building tests)
 
-Install prerequisites on Debian GNU/Linux 'Bullseye' 11:
+Install prerequisites on Debian stable:
 
     apt-get install \
     cmake \
-    pkg-config \
     libcjson-dev \
     libcurl4-openssl-dev \
+    libgcrypt-dev \
     libglib2.0-dev \
-    libgpgme-dev \
     libgnutls28-dev \
-    uuid-dev \
-    libgcrypt-dev \
-    libssh-dev \
+    libgpgme-dev \
     libhiredis-dev \
-    libxml2-dev \
-    libpcap-dev \
     libnet1-dev \
-    libpaho-mqtt-dev
-
+    libpaho-mqtt-dev \
+    libpcap-dev \
+    libssh-dev \
+    libxml2-dev \
+    pkg-config \
+    uuid-dev
 
-Prerequisites for Optional Features
------------------------------------
+## Prerequisites for Optional Features
 
 Certain features of gvm-libs are optional and require the following:
 
 Prerequisites for LDAP authentication:
+
 * libldap2 library >= 2.4.44 (util) (Debian package: libldap2-dev)
 
 Prerequisites for RADIUS authentication:
+
 * libradcli4 library >= 1.2.6 (util) (Debian package: libradcli-dev)
 * Alternative: libfreeradius3 library (util) (Debian package: libfreeradius-dev)
 
@@ -78,8 +80,7 @@ Install prerequisites for optional features on Debian GNU/Linux 'Buster' 10:
     libldap2-dev \
     libradcli-dev
 
-Compiling gvm-libs
-------------------
+## Compiling gvm-libs
 
 If you have installed required libraries to a non-standard location, remember to
 set the `PKG_CONFIG_PATH` environment variable to the location of your pkg-config
@@ -92,6 +93,7 @@ Create a build directory and change working directory into it with
         mkdir build && cd build
 
 Afterwards you can run `cmake` with different options:
+
 * Configure `gvm-libs` build with a custom installation path:
 
         cmake -DCMAKE_INSTALL_PREFIX=/path/to/your/installation ..
@@ -131,8 +133,7 @@ directory you created above.
     cd .. && rm -rf build
 
 
-Configurable Options
---------------------
+## Configurable Options
 
 During compilation, the build process uses a set of compiler options which
 enable very strict error checking and asks the compiler to abort should it detect
@@ -149,8 +150,7 @@ Portal](https://community.greenbone.net/c/gse). Don't forget to include the
 name and version of your compiler and distribution in your message.
 
 
-Building GVM Libraries statically linked
-----------------------------------------
+## Building GVM Libraries statically linked
 
 If you want to build a statically linked version -- for example to subsequently
 build a statically linked program using this library -- you need statically