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 #
## About ##
Provides C++ bindings and class structure to the [libclang](http://www.llvm.org) C library.
## About ##
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.
## Dependencies ##
* libclang
## Installation ##
See [installation guide](https://github.com/cppit/libclangmm/blob/master/docs/install.md)
# 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.
```sh
# enable_testing()
# add_subdirectory(tests)
```
Then simply:
```sh
cmake .
make
ctest
```
If you want an more detailed look at the tests run the binary instead
```sh
cmake .
make
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).
## Dependencies ##
* libclang
## Installation ##
See [installation guide](https://github.com/cppit/libclangmm/blob/master/docs/install.md)
# Tests #
To run the unit tests, first enable the CMake option `LIBCLANGMM_BUILD_TESTS`:
```sh
cmake -DLIBCLANGMM_BUILD_TESTS=ON .
```
Then, simply call:
```sh
make
ctest
```
You may also run the test binary directly to get more details:
```sh
make
cd tests
./clangmm_tests --log_level=all
```
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).

Loading…
Cancel
Save