Skip to content

Commit

Permalink
Add CMake instructions to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
drichardson committed Apr 21, 2021
1 parent 3a18733 commit a7ab347
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,40 @@ A huffman coding library and command line interface to the library. The encoder

libhuffman has functions for encoding and decoding both files and memory.

To build, run:

## Makefile Build

To build:

make

To run unit tests, run:
To run unit tests:

make check

To run unit tests under valgrind, run:
To run unit tests under valgrind:

make valgrind_check


## CMake Build

To build:

mkdir build
cd build
cmake ..
cmake --build .

To run all tests:

ctest

To run unit tests:

ctest -R ^check$

To run unit tests under valgrind:

ctest -R ^valgrind_check$

0 comments on commit a7ab347

Please sign in to comment.