Browse Source

Updated readme file with information about CMake option for enabling unit tests.

merge-requests/37/head
Patrick Lühne 10 years ago
parent
commit
9154d5fe2b
  1. 60
      README.md

60
README.md

@ -1,36 +1,30 @@
# libclangmm - an easy to use C++-wrapper for libclang # # libclangmm - an easy to use C++-wrapper for libclang #
## About ## ## About ##
Provides C++ bindings and class structure to the [libclang](http://www.llvm.org) C library. Provides C++ bindings and class structure to the [libclang](http://www.llvm.org) C library.
Developed for [juCi++](https://github.com/cppit/jucipp) - a lightweight platform independent C++-IDE. Developed for [juCi++](https://github.com/cppit/jucipp) - a lightweight platform independent C++-IDE.
## Dependencies ## ## Dependencies ##
* libclang * libclang
## Installation ## ## Installation ##
See [installation guide](https://github.com/cppit/libclangmm/blob/master/docs/install.md) See [installation guide](https://github.com/cppit/libclangmm/blob/master/docs/install.md)
# Tests # # Tests #
The compilation of the tests are disabled due to ease of installation. Simply enter CMakeList.txt and uncomment the last two lines in the file to enable testing. To run the unit tests, first enable the CMake option `LIBCLANGMM_BUILD_TESTS`:
```sh
```sh cmake -DLIBCLANGMM_BUILD_TESTS=ON .
# enable_testing() ```
# add_subdirectory(tests) Then, simply call:
``` ```sh
Then simply: make
```sh ctest
cmake . ```
make You may also run the test binary directly to get more details:
ctest ```sh
``` make
If you want an more detailed look at the tests run the binary instead cd tests
```sh ./clangmm_tests --log_level=all
cmake . ```
make For more options, see the [documentation of boost’s unit testing framework](http://www.boost.org/doc/libs/1_58_0/libs/test/doc/html/utf/user-guide/runtime-config/reference.html).
cd tests
./clangmm_tests --log_level=all
```
To see more log parameters see [here](http://www.boost.org/doc/libs/1_58_0/libs/test/doc/html/utf/user-guide/runtime-config/reference.html).

Loading…
Cancel
Save