about summary refs log tree commit diff stats
diff options
context:
space:
mode:
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md index 846ec94..3b22eee 100644 --- a/README.md +++ b/README.md
@@ -13,7 +13,7 @@ It is written with a simple-to-use approach while also exposing features that al
13The library is fully documented with code comments in both the headers files and the code files. 13The library is fully documented with code comments in both the headers files and the code files.
14 14
15## Building and Installing 15## Building and Installing
16### Linux 16### Building as Release
17``` 17```
18$ mkdir build 18$ mkdir build
19$ cd build 19$ cd build
@@ -21,6 +21,15 @@ $ cmake ..
21$ make 21$ make
22$ sudo make install 22$ sudo make install
23``` 23```
24### Building as Debug
25You can also specify `-DCMAKE_BUILD_TYPE=Debug` to CMake, to generate a library with debug symbols present. This also sets the library version number to `dev-BRANCHNAME-COMMITHASH`.
26```
27$ mkdir build
28$ cd build
29$ cmake .. -DCMAKE_BUILD_TYPE=Debug
30$ make
31$ sudo make install
32```
24 33
25## Examples 34## Examples
26Some examples are available in the `examples/` directory, which show the general flow of how libwifi is used to generate and parse different types of 802.11 frame. 35Some examples are available in the `examples/` directory, which show the general flow of how libwifi is used to generate and parse different types of 802.11 frame.