how to use mstch in your project
This commit is contained in:
parent
12a1399090
commit
f9c06163ee
2 changed files with 29 additions and 3 deletions
27
README.md
27
README.md
|
@ -204,9 +204,23 @@ Output:
|
||||||
- Boost 1.54+ for [Boost.Variant](http://www.boost.org/libs/variant)
|
- Boost 1.54+ for [Boost.Variant](http://www.boost.org/libs/variant)
|
||||||
- CMake 3.0+ for building
|
- CMake 3.0+ for building
|
||||||
|
|
||||||
## Installing
|
## Using mstch in your project
|
||||||
|
|
||||||
From the root of the source tree:
|
If you are using CMake, the easiest way to include mstch in your project is to
|
||||||
|
copy the whole directory to your source tree, and use `add_subdirectory` in your
|
||||||
|
CMakeLists.txt. This will set a variable named `mstch_INCLUDE_DIR` that contains
|
||||||
|
its include path, and add a static library target named mstch. For example:
|
||||||
|
|
||||||
|
```cmake
|
||||||
|
add_subdirectory(external/mstch)
|
||||||
|
|
||||||
|
include_directories(${mstch_INCLUDE_DIR})
|
||||||
|
|
||||||
|
target_link_libraries(your_project mstch)
|
||||||
|
```
|
||||||
|
|
||||||
|
If you prefer to install the library globally, you can simply do the following
|
||||||
|
from the root of the source tree:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ mkdir build
|
$ mkdir build
|
||||||
|
@ -216,6 +230,15 @@ From the root of the source tree:
|
||||||
$ make install
|
$ make install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The install command may require root privileges. This will also install CMake
|
||||||
|
config files, so you can use use `find_package` in your CMakeLists.txt:
|
||||||
|
|
||||||
|
```cmake
|
||||||
|
find_package(mstch)
|
||||||
|
|
||||||
|
target_link_libraries(your_project mstch::mstch)
|
||||||
|
```
|
||||||
|
|
||||||
## Running the unit tests
|
## Running the unit tests
|
||||||
|
|
||||||
Unit tests are using the [Catch](https://github.com/philsquared/Catch) framework,
|
Unit tests are using the [Catch](https://github.com/philsquared/Catch) framework,
|
||||||
|
|
|
@ -1,7 +1,10 @@
|
||||||
find_package(Boost 1.54 REQUIRED)
|
find_package(Boost 1.54 REQUIRED)
|
||||||
|
|
||||||
|
set(mstch_INCLUDE_DIR
|
||||||
|
${PROJECT_SOURCE_DIR}/include CACHE STRING "mstch include directory")
|
||||||
|
|
||||||
include_directories(
|
include_directories(
|
||||||
${PROJECT_SOURCE_DIR}/include
|
${mstch_INCLUDE_DIR}
|
||||||
${Boost_INCLUDE_DIR})
|
${Boost_INCLUDE_DIR})
|
||||||
|
|
||||||
set(SRC
|
set(SRC
|
||||||
|
|
Loading…
Reference in a new issue