cplusplus_template

This repository is base project template for C++

Features

Continuous Integration (CI)

• Formating
• Linting
• Unit testing
• API document generation
• GitHub action

Docker support

• Our docker supports development environment out of box.
  • zsh with powerlevel10k theme
  • tmux
  • VIM with YCM support.

git clone https://github.com/j-marple-dev/cplusplus_template.git
cd cplusplus_template
./run_docker.sh build
# You can add build options
# ./run_docker.sh build --no-cache

./run_docker.sh run
# You can add running options
# ./run_docker.sh run -v $DATA_PATH:/home/user/data

# Re-run last docker container
./run_docker.sh exec

Executable and unit test files

• Locate executable main cpp files on src/*.cpp. And ${PROJECT_NAME}-${FILE_NAME} binary files will be built. No need to modify CMakeLists.txt.
• Locate unit test cpp files on test/test_*.cpp. And test-${PROJECT_NAME}-${FILE_NAME} binary files will be built. No need to modify CMakeLists.txt.

Build & Unit test

git clone https://github.com/j-marple-dev/cplusplus_template.git
cd cplusplus_template
./run_check.sh build  # Equivalent to mkdir -p ./build && cd build && cmake .. && make
./run_check.sh test  # Equivalent to mkdir -p ./build && cd build && cmake .. && make && make test

Developers

• Please refer to CODE_OF_CONDUCT guide.