Skip to content

Commit

Permalink
Merge pull request #23 from testcontainers/building_the_project
Browse files Browse the repository at this point in the history
Document building the project + Support skipping demos
  • Loading branch information
oleg-nenashev authored Nov 29, 2023
2 parents 4ba7f1b + ff53c43 commit f3d3362
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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()
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit f3d3362

Please sign in to comment.