cpp project

C ++项目的锅炉板

这是用于C ++项目的锅炉板。你得到的：

• 在不同文件夹中分开的来源，标题和主电源
• 使用现代CMAKE，以更轻松地编译
• 使用医生进行测试的设置
• 通过Travis-CI，Appveyor和GitHub动作进行连续测试，并支持C ++ 17。
• 代码覆盖范围报告，包括自动上传到coveralls.io和/或codecov.io
• 使用doxygen的代码文档

结构

 .
├── CMakeLists.txt
├── app
│   └── main.cpp
├── include
│   ├── example.h
│   └── exampleConfig.h.in
├── src
│   └── example.cpp
└── tests
    ├── dummy.cpp
    └── main.cpp

源插入src/，include/，应用程序中的主要程序中的标题文件，测试进行/（默认情况下汇编为unit_tests ）。

如果添加新的可执行文件，例如app/hello.cpp ，您只需要将以下两行添加到cmakelists.txt：

 add_executable (main app/main.cpp)   # Name of exec. and location of file.
target_link_libraries (main PRIVATE ${LIBRARY_NAME} )  # Link the executable to lib built from src/*.cpp (if it uses it).

您可以在cmakelists.txt中的Build部分下找到在app/main.cpp中构建main的示例源代码。如果您制作的可执行文件不使用SRC/中的库，则仅需要第一行。

建筑

通过制作构建目录（IE build/ ）来构建，在该DIR中运行cmake ，然后使用make来构建所需的目标。

例子：

mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=[Debug | Coverage | Release]
make
./main
make test      # Makes and runs the tests.
make coverage  # Generate a coverage report.
make doc       # Generate html documentation. 

.gitignore

.gitignore文件是github c ++。gitignore文件的副本，添加了忽略构建目录（ build/ ）。

服务

如果存储库被Travis-CI激活，则将在每个提交上构建和执行单位测试。如果使用Appveyor激活存储库，也是如此。

如果将存储库用Coveralls/codecov激活，那么到Travis的部署还将计算代码覆盖范围并将其上传到Coveralls.io和/或Codecov.io

设置

使用GitHub模板

单击Use this template按钮从此模板中创建新的存储库。

从命令行

启动新项目时，您可能不希望此存储库的历史记录。要开始新鲜，您可以使用以下设置脚本：

git clone https://github.com/bsamseth/cpp-project  # Or use ssh-link if you like.
cd cpp-project
bash setup.sh

结果是一个新的git存储库，其中一个提交添加了锅炉板上的所有文件。