diff --git a/Installation-from-source.md b/Installation-from-source.md new file mode 100644 index 0000000..a236c09 --- /dev/null +++ b/Installation-from-source.md @@ -0,0 +1,40 @@ +# Installation from source + +## Install build-dependencies + +## Debian/Ubuntu + +In order to build on Debian/Ubuntu make sure you install the following build-dependencies + +``` +$ sudo apt build-essential cmake ragel pkg-config libsqlite3-dev libpcap-dev +``` + +## Configure & build + +In order to configure with `cmake` first create and cd into a build directory: + +``` +$ mkdir build +$ cd build +``` + +Then call `cmake` from inside the `build` directory: + +``` +$ cmake ../ +``` + +Common options for Cmake are: + +* `-DBUILD_STATIC_LIBS=On/Off` Build static libraries +* `-DBUILD_SHARED_LIBS=On/Off` Build shared libraries +* `-DCMAKE_BUILD_TYPE=[Release|Debug|RelWithDebInfo|MinSizeRel]` Configure build type and determine optimizations and certain features, for examples, Fat runtimes are not compatible with Debug mode at the moment. + +And then you can run `make` in the same directory, if you have a multi-core system with `N` cores, running + +``` +$ make -j +``` + +will speed up the process. If all goes well, you should have the vectorscan library