mirror of
https://github.com/TheLartians/ModernCppStarter.git
synced 2025-08-30 21:51:12 +02:00
Implemented Docker instructions
This commit is contained in:
parent
1aab3e91f2
commit
07756037a6
1 changed files with 42 additions and 0 deletions
42
README.md
42
README.md
|
@ -119,6 +119,48 @@ cmake --build build --target fix-format
|
|||
cmake --build build --target GenerateDocs
|
||||
```
|
||||
|
||||
### Build and Run Docker image
|
||||
|
||||
The project has support to Docker, that allows building and running tests inside a container.
|
||||
This container builds all targets, so you can run any of them passing a command after "sh -c".
|
||||
|
||||
```bash
|
||||
docker build . -t modern-cpp-starter
|
||||
|
||||
docker run modern-cpp-starter
|
||||
```
|
||||
|
||||
Running tests
|
||||
|
||||
```bash
|
||||
docker build . -t modern-cpp-starter
|
||||
|
||||
docker run modern-cpp-starter sh -c "./build/test/GreeterTests"
|
||||
```
|
||||
|
||||
### Build and Run Docker Compose
|
||||
|
||||
The project has support to Docker Compose, that allows building and running your project with other containers.
|
||||
This container builds all targets, so you can run any of them passing a command after "sh -c".
|
||||
|
||||
Running all containers
|
||||
|
||||
```bash
|
||||
docker-compose up --build
|
||||
```
|
||||
|
||||
Running only your project
|
||||
|
||||
```bash
|
||||
docker-compose run application
|
||||
```
|
||||
|
||||
Runing tests
|
||||
|
||||
```bash
|
||||
docker-compose run application sh -c "./build/test/GreeterTests"
|
||||
```
|
||||
|
||||
### Additional tools
|
||||
|
||||
The test and standalone subprojects include the [tools.cmake](cmake/tools.cmake) file which is used to import additional tools on-demand through CMake configuration arguments.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue