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

特此免費授予獲得此軟件副本和相關文檔文件副本（“軟件”）的任何人，以無限制處理該軟件，包括無限制的使用權，複製，複製，修改，合併，合併，發布，分發，分發，分發，訂婚，和/或允許軟件的副本，並允許對以下條件提供以下條件，以下是以下條件。

上述版權通知和此許可通知應包含在軟件的所有副本或大量部分中。

該軟件是“原樣”提供的，沒有任何形式的明示或暗示保證，包括但不限於適銷性，特定目的的適用性和非侵權的保證。在任何情況下，作者或版權持有人都不應對任何索賠，損害賠償或其他責任責任，無論是在合同，侵權的訴訟中還是其他責任，是由軟件，使用或與軟件中的使用或其他交易有關的。