build: adding description on code coverage to README
@@ -21,8 +21,7 @@ much more.
For more information, please refer to the
[documentation](https://liquidsdr.org/doc) online.
-Installation and Dependencies
------------------------------
+## Installation and Dependencies ##
liquid-dsp only relies on `libc` and `libm` (standard C and math)
libraries to run; however liquid will take advantage of other libraries
@@ -73,9 +72,24 @@ make target `check`, viz.
make check
-There are currently more than 90,000 checks to verify functional correctness.
+There are currently more than 110,000 checks to verify functional correctness.
Drop me a line if these aren't running on your platform.
+### Testing Code Coverage ###
+
+In addition to the full test suite, you can configure `gcc` to export symbol
+files to check for code coverage and then use `gcovr` to generate a full
+report of precisely which lines are covered in the autotests. These symbol
+files aren't generated by default and need to be enabled at compile-time
+through a configure flag:
+
+ ./configure --enable-coverage
+
+Running the tests and generating the report through `gcovr` can be invoked
+with the `coverage` make target:
+
+ make coverage
+
### Examples ###
Nearly all signal processing elements have a corresponding example in
@@ -102,8 +116,7 @@ following command:
make bench
-Available Modules
------------------
+## Available Modules ##
* _agc_: automatic gain control, received signal strength
* _audio_: source audio encoders/decoders: cvsd, filterbanks
