diff --git a/CMakeLists.txt b/CMakeLists.txt index 276714d..b6183a0 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -7,4 +7,6 @@ include_directories(${CMAKE_CURRENT_BINARY_DIR}/testcontainers-c) add_subdirectory(testcontainers-c) add_subdirectory(modules) -add_subdirectory(demo) +if(NOT DEFINED SKIP_DEMOS) + add_subdirectory(demo) +endif() diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8214698..605ce3e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,23 @@ To propose a code patch, just submit a pull request to the repository. No need to create a GitHub issue if you want to suggest a simple patch, pull requests are more than enough for it. +## Building the project + +You need CMake 3.16.3 and Golang 1.19+. +At the moment there are not so many configuration flags, so the build is straightforward: + +```shell +cmake . +cmake --build . +ctest --output-on-failure +``` + +To skip the demo builds and tests, use the `SKIP_DEMOS` variable: + +```shell +cmake -DSKIP_DEMOS=true . +``` + ## Codestyle ### Public APIs