cleanCppProject

CleanCpproject

这是C ++项目的空框架。在不关心项目/构建环境设置的情况下，它应该有助于启动一个新项目。

特征

• 现代，简单的cmake构建脚本，分为几个组件，以供可读性。
• 所有事物的理智而简单的目标（请参见目标部分）。
• 可以生产DEB ， RPM ， Windows Installer ， Bundle App ， DMG和各种压缩软件包的CPACK脚本。
• 通过CTEST进行测试。
• 单位测试通过捕获量。
• 通过doxygen生成文档（代码 + Wiki +带有graphviz和planuml的UML图）。
• 静态分析支持（Clang-Tidy，Cppcheck）。
• 通过消毒剂的动态分析帮助者（请参阅CMAKE/SANITIZERS.CMAKE）。
• 与您喜欢的Linux发行版，Windows和MacOS一起使用。
• Gitlab CI和Travis CI配置示例。
• 支持金色链接器，以更快地链接时间。
• 用于添加在配置或构建过程中下载的外部依赖项的帮助者。
  • 请参阅external/CMakeLists.txt和cmake/cleanCppExtension.cmake

重要页面

• 设计文件
• 戒酒列表（仅doxygen）
• 基本目录结构
• 如何开始工作

todo看如何工作

如何将其转换为您的新项目

 git clone https://github.com/kracejic/cleanCppProject.git yourNewProject
cd yourNewProject
mv .git .git-cleanCppProject
git init
git add .
git commit -m "first commit"

有关如何开始工作的更多信息。

如何与我们保持联系

我们将定期改进此存储库，如果您想从我们那里获得更多信息，请尝试提取主要仓库。

 cd yourNewProject/ 
git pull --git-dir='.git-cleanCppProject'

建筑说明

先决条件

• Cmake 3.2和更新
• 支持C ++ 14的编译器
• git-用于下载外部资源
• Doxygen for Docs（用于文档中更多图的GraphViz，用于更多UML图的Plantuml ，Plantuml需要Java）
• 用于静态分析和格式化的叮当作用
• CPCHECK进行另一个静态分析

Linux上的先决条件

• Arch Linux： sudo pacman -S cmake g++ graphviz git clang clang-tools-extra cppcheck java-runtime-common cppcheck

  • 下载plantuml.jar，并将其放在路径指向的地方

• Ubuntu 16.04： sudo apt-get install cmake g++ graphviz plantuml git clang clang-tidy clang-format cppcheck

窗户上的先决条件

两种经过测试的方法：

• 基于MSYS2

  • 最小值： pacman -S cmake g++ git
  • 其他软件pacman -S clang mingw-w64-x86_64-clang-tools-extra mingw-w64-x86_64-clang-analyzer doxygen
  • 对于文档中的图形，请安装GraphViz（到c:Program FilesGraphviz ，以便脚本可以找到它）并将其bin子目录添加到路径中，请安装Java（在路径上有bin目录），下载Plantuml Jar文件并将其放在路径上。

• Microsoft Visual Studio

  • 安装CMAKE
  • 安装git
  • 有关其他功能，请安装带有工具，doxygen，graphviz，plantuml，java的clang，并将它们添加到路径（未测试）

MacOS的先决条件

• MacOS Sierra brew install llvm doxygen cppcheck graphviz

建立在Linux＆MacOS上

标准制造件：

 mkdir build ; cd build
cmake ..
make -j8

忍者建立女巫clang，构建All+Doc并将其安装到Dist文件夹：

 mkdir build ; cd build
cmake -GNinja -DCMAKE_CXX_COMPILER="clang++" ..
ninja all doc install

释放构建将在sudo make install后将其安装到/usr中

 mkdir build ; cd build
cmake .. -DCMAKE_INSTALL_PREFIX="/usr" -DCMAKE_BUILD_TYPE="Release"
make -j8 all
sudo make install

在窗户上构建

使用MSYS2 + Ninja在Windows上构建

在窗户上，您应该更喜欢忍者，因为它比制造快得多（但在外壳中没有颜色）。

与GCC：

 mkdir build ; cd build
cmake -GNinja ..
ninja install

您可以使用cmake -G "MSYS Makefiles" ..如果要使用make。

使用Microsoft Visual Studio在Windows上构建14

首先，您可以在Main CMakeLists.txt中更改项目名称。只需使用该项目访问文件夹，创建新目录并使用以下方式创建项目文件：

 mkdir buildmsvc
cd buildmsvc
cmake -G "Visual Studio 14 2015" ..

现在，您可以使用Visual Studio打开.sln文件。您需要右键单击可执行的目标并将其设置为启动项目。为了真正看到要启动的控制台窗口而不调试，因为仅在调试模式下运行时，控制台寡妇关闭了太快。

目标

注意：某些目标的可用性取决于某些可执行文件的可用性（例如格式目标的clang-format）

• 建造
  • 所有（默认值为未提供目标）
  • 干净的
  • 安装- 将二进制文件安装到cmake_install_prefix中
  • axpleapp-构建审查式二进制
  • extpleapp -run-构建，安装和运行Exteppleapp二进制（为了方便起见）
  • extpleapp -gdb-在GDB中构建，安装和运行estecpleapp二进制（为了方便起见）
  • 运行- extpleapp -run的别名（为了使其简短）
• 测试
  • 检查- 运行整个测试套件（请参阅测试/cmakelists.txt）
  • CheckverBose-运行整个测试套件（请参阅test/cmakelists.txt），但更多的详细信息
  • 单位- 仅构建和运行单元测试（请参阅test/cmakelists.txt）
  • unitall-与以前相同，甚至仅打印成功的单位测试结果
• 发行
  • 软件包- 构建软件包（ZIP，DEB，RPM，Windows安装程序，具体取决于OS）
• 各种各样的
  • 文档- 构建文档（如果可用Doxygen）
    • 可以在build_dir/doc/doc/index.html中找到文档
    • 如果您希望它们成为安装软件包的一部分，请在doc/CMakeLists.txt的末尾进行删节部分
  • 格式- 在所有源文件上运行clang-format（使用项目的根目录中的.clang-format）
  • GDB-使用GDB执行可执行的目标（不起作用，需要GDB）
• 静态分析
  • 整理- 对所有来源运行clang静态分析
  • cppcheck-在所有文件上致电cppcheck（另一个静态分析）
• 外部的
  • 更新- 更新所有外部资源/项目

CMAKE变量

• -DCMAKE_INSTALL_PREFIX安装位置
• -DVERSION_HOST构建计算机名称，请参阅version.h.in
• -DCMAKE_BUILD_TYPE用于构建类型
• -DMEASURE_ALL=ON/OFF测量所有汇编的时间，最好与单线构建一起使用。需要time命令（UNIX）。
• -DUSE_GOLD_LINKER=ON/OFF是否要与Gold Linker链接。

执照

版权（C）2019 Kracejic

特此免费授予获得此软件副本和相关文档文件副本（“软件”）的任何人，以无限制处理该软件，包括无限制的使用权，复制，复制，修改，合并，合并，发布，分发，分发，分发，订婚，和/或允许软件的副本，并允许对以下条件提供以下条件，以下是以下条件。

上述版权通知和此许可通知应包含在软件的所有副本或大量部分中。

该软件是“原样”提供的，没有任何形式的明示或暗示保证，包括但不限于适销性，特定目的的适用性和非侵权的保证。在任何情况下，作者或版权持有人都不应对任何索赔，损害赔偿或其他责任责任，无论是在合同，侵权的诉讼中还是其他责任，是由软件，使用或与软件中的使用或其他交易有关的。