diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 38 |
1 files changed, 23 insertions, 15 deletions
@@ -23,41 +23,49 @@ if some features of the library are disabled. In order to compile, execute: ```Shell -./configure +# Create the build directory +mkdir build +cd build + +# Configure the project. Add any relevant configuration flags +cmake ../ + +# Compile! make ``` Note that by default, only the shared object is compiled. If you would -like to generate a static library file as well, run: +like to generate a static library file, run: ```Shell -./configure --enable-static +cmake ../ -DLIBTINS_BUILD_SHARED=0 ``` -The generated static/shared library files will be located in the .libs -directory. +The generated static/shared library files will be located in the +_build/lib_ directory. -libtins is noticeable faster if you enable C++11 support. Therefore, if -your compiler supports this standard, then you should enable it. In -order to do so, use the --enable-c++11 switch: +libtins is noticeable faster if you enable _C++11_ support. Therefore, +if your compiler supports this standard, then you should enable it. +In order to do so, use the _LIBTINS_ENABLE_CXX11_ switch: ```Shell -./configure --enable-c++11 +cmake ../ -DLIBTINS_ENABLE_CXX11=1 ``` -If you want to disable WPA2 decryption support, which will remove -openssl as a dependency for compilation, use the --disable-wpa2 switch: +If you want to disable _WPA2_ decryption support, which will remove +openssl as a dependency for compilation, use the +_LIBTINS_ENABLE_WPA2_ switch: ```Shell -./configure --disable-wpa2 +cmake ../ -DLIBTINS_ENABLE_WPA2=0 ``` If you want to disable IEEE 802.11 support(this will also disable RadioTap and WPA2 decryption), which will reduce the size of the -resulting library in around 20%, use the --disable-dot11 switch: +resulting library in around 20%, use the _LIBTINS_ENABLE_DOT11_ switch: ```Shell -./configure --disable-dot11 +cmake ../ -DLIBTINS_ENABLE_DOT11=0 ``` ## Installing ## @@ -69,7 +77,7 @@ shared object, execute as root: make install ``` -This will install the shared object typically in /usr/local/lib. Note +This will install the shared object typically in _/usr/local/lib_. Note that you might have to update ldconfig's cache before using it, so in order to invalidate it, you should run(as root): |