From c949825b74a68115adb00ac66969c5e1b2fe3e57 Mon Sep 17 00:00:00 2001 From: Marc Date: Sun, 9 Jan 2022 17:03:33 +0000 Subject: misc: Update README.md --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) (limited to 'README.md') 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 It 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. -The 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`. +The library is fully documented with code comments in both the headers files and the code files. ## Building and Installing ### Linux @@ -26,14 +26,22 @@ $ sudo make install 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. ## Running Tests +Using ctest, you can run the tests for the parse and generation functions of libwifi. ``` $ cd test/ $ mkdir build $ cd build $ cmake .. -$ make -$ sudo iw set type monitor && sudo ip link set dev up -$ ./test-program +$ make && make test ``` +## Using Utilities +Included in the source are some utilities that use libwifi, and serve as references or examples if you need them. +``` +$ cd utils/ +$ mkdir build +$ cd build +$ cmake .. +$ make +``` -- cgit 1.4.1