about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/README.md b/README.md index 08f4a56..846ec94 100644 --- a/README.md +++ b/README.md
@@ -10,7 +10,7 @@ libwifi is a C library with a permissive license for generating and parsing a wi
10 10
11It is written with a simple-to-use approach while also exposing features that allow more advanced use, with clean and readable code being a priority. Other goals of the library include cross-architecture support, clean compilation without warnings and strict error checking. 11It is written with a simple-to-use approach while also exposing features that allow more advanced use, with clean and readable code being a priority. Other goals of the library include cross-architecture support, clean compilation without warnings and strict error checking.
12 12
13The library is fully documented with code comments in both the headers files and the code files, and also has doxygen HTML documentation in `docs/html`. 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### Linux
@@ -26,14 +26,22 @@ $ sudo make install
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. 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.
27 27
28## Running Tests 28## Running Tests
29Using ctest, you can run the tests for the parse and generation functions of libwifi.
29``` 30```
30$ cd test/ 31$ cd test/
31$ mkdir build 32$ mkdir build
32$ cd build 33$ cd build
33$ cmake .. 34$ cmake ..
34$ make 35$ make && make test
35$ sudo iw <interface> set type monitor && sudo ip link set dev <interface> up
36$ ./test-program
37``` 36```
38 37
38## Using Utilities
39Included in the source are some utilities that use libwifi, and serve as references or examples if you need them.
40```
41$ cd utils/
42$ mkdir build
43$ cd build
44$ cmake ..
45$ make
46```
39 47