diff options
| author | Marc <foxtrot@malloc.me> | 2022-01-28 23:59:31 +0000 |
|---|---|---|
| committer | Marc <foxtrot@malloc.me> | 2022-01-28 23:59:31 +0000 |
| commit | 9ba28270d5f56b1d7ad766a0f9fe3a217aa20963 (patch) | |
| tree | 0c49b74b815d245d8b1b7f17d12426ed66316424 /README.md | |
| parent | 762f2698e2fa30d4c4d3f5b3dca2ff60d564783d (diff) | |
| download | libwifi-9ba28270d5f56b1d7ad766a0f9fe3a217aa20963.tar.gz libwifi-9ba28270d5f56b1d7ad766a0f9fe3a217aa20963.tar.bz2 libwifi-9ba28270d5f56b1d7ad766a0f9fe3a217aa20963.zip | |
misc: Update README to include details about debug builds
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
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 | |||
| 13 | The library is fully documented with code comments in both the headers files and the code files. | 13 | The 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 | ||
| 25 | You 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 |
| 26 | Some 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. | 35 | Some 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. |