Skip to content
This repository has been archived by the owner on Apr 19, 2023. It is now read-only.

Latest commit

 

History

History
71 lines (55 loc) · 2.46 KB

README_docker.md

File metadata and controls

71 lines (55 loc) · 2.46 KB
Raw

Docker Instructions

If you have Docker installed, you can run this in your terminal, when the Dockerfile is inside the .devcontainer directory:

docker build -f ./.devcontainer/Dockerfile --tag=my_project:latest .
docker run -it my_project:latest

This command will put you in a bash session in a Ubuntu 20.04 Docker container, with all of the tools listed in the Dependencies section already installed. Additionally, you will have g++-11 and clang++-13 installed as the default versions of g++ and clang++.

If you want to build this container using some other versions of gcc and clang, you may do so with the GCC_VER and LLVM_VER arguments:

docker build --tag=myproject:latest --build-arg GCC_VER=10 --build-arg LLVM_VER=11 .

The CC and CXX environment variables are set to GCC version 11 by default. If you wish to use clang as your default CC and CXX environment variables, you may do so like this:

docker build --tag=my_project:latest --build-arg USE_CLANG=1 .

You will be logged in as root, so you will see the # symbol as your prompt. You will be in a directory that contains a copy of the cpp_starter_project; any changes you make to your local copy will not be updated in the Docker image until you rebuild it. If you need to mount your local copy directly in the Docker image, see Docker volumes docs. TLDR:

docker run -it \
	-v absolute_path_on_host_machine:absolute_path_in_guest_container \
	my_project:latest

You can configure and build as directed above using these commands:

/starter_project# mkdir build
/starter_project# cmake -S . -B ./build
/starter_project# cmake --build ./build

You can configure and build using clang-13, without rebuilding the container, with these commands:

/starter_project# mkdir build
/starter_project# CC=clang CXX=clang++ cmake -S . -B ./build
/starter_project# cmake --build ./build

The ccmake tool is also installed; you can substitute ccmake for cmake to configure the project interactively. All of the tools this project supports are installed in the Docker image; enabling them is as simple as flipping a switch using the ccmake interface. Be aware that some of the sanitizers conflict with each other, so be sure to run them separately.

A script called build_examples.sh is provided to help you to build the example GUI projects in this container.