cleanCppProject

CleanCppProject

これは、C ++のプロジェクトの空のフレームです。プロジェクト/ビルド環境のセットアップをあまり気にせずに、新しいプロジェクトを開始するのに役立つはずです。

特徴

• 読みやすくするためにいくつかのコンポーネントに分割されたモダンでシンプルなCmakeビルドスクリプト。
• すべての正気で単純なターゲット（ターゲットセクションを参照）。
• DEB 、 RPM 、 Windowsインストーラー、バンドルアプリ、 DMG、およびさまざまな圧縮パッケージを生成できるCPACKスクリプト。
• CTESTを介したテスト。
• 漁獲による単体テスト。
• Doxygen経由のドキュメント生成（GraphVizおよびPlanumlを使用したコード + Wiki + UMLダイアグラム）。
• 静的分析サポート（Clang-Tidy、cppcheck）。
• 消毒剤を介した動的分析ヘルパー（cmake/sanitizers.cmakeを参照）。
• お気に入りのLinuxディストリビューション、Windows、MacOSで動作します。
• Gitlab CIおよびTravis CI構成の例。
• リンク時間を速くするためのゴールドリンカーのサポート。
• 構成またはビルド中にダウンロードされた外部依存関係を追加するためのヘルパー。
  • external/CMakeLists.txtおよびcmake/cleanCppExtension.cmake参照してください

重要なページ

• デザインドキュメント
• Todosのリスト（Doxygenのみ）
• 基本的なディレクトリ構造
• 作業を開始する方法

todoは、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（ graphviz docsのより多くのグラフ、plantumlより多くのuml図、plantuml need java）
• 静的分析とフォーマットのためのClang-Tools
• 別の静的分析のためのcppcheck

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

Windowsの前提条件

テストされた2つの方法：

• 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（パスにビンディレクトリを持っている）をインストールし、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

Ninja Build Witch 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

Windowsの上に構築します

MSYS2 + NINJAを使用してWindowsに構築します

Windowsでは、忍者が作るよりもはるかに速いので、忍者を好むはずです（ただし、シェルには色がありません）。

GCCで：

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

cmake -G "MSYS Makefiles" ..

Microsoft Visual Studio 14を使用してWindowsに構築します

最初に、メインCMakeLists.txtのプロジェクト名を変更することができます。プロジェクトでフォルダに移動して、新しいディレクトリを作成し、これを使用してプロジェクトファイルを作成するだけです。

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

また、Visual Studioで.slnファイルを開くことができます。実行可能なターゲットを右クリックし、スタートアッププロジェクトとして設定する必要があります。デバッグモードでのみ実行すると、コンソールの未亡人が速すぎるため、デバッグせずに開始するコンソールウィンドウを実際に表示するには。

ターゲット

注：一部のターゲットの可用性は、特定の実行可能ファイル（フォーマットターゲットのClang-Formatなど）に依存します。

• 建てる
  • すべて（ターゲットが提供されていない場合はデフォルト）
  • クリーン
  • インストール- バイナリをcmake_install_prefixにインストールします
  • ExamPlearpp-試験バイナリをビルドします
  • Examplearpp -run-試験バイナリをビルド、インストール、実行する（便利なため）
  • Examplearpp -GDB -GDBで試験バイナリをビルド、インストール、実行する（便利なため）
  • 実行- ExamPlearpp -Runのエイリアス（短くするため）
• テスト
  • チェック- テストスイート全体を実行します（test/cmakelists.txtを参照）
  • Checkverbose-テストスイート全体を実行します（test/cmakelists.txtを参照）が、もっと冗長
  • ユニット- ユニットテストのみをビルドして実行する（test/cmakelists.txtを参照）
  • Unitall-以前と同じで、成功したユニットテストの結果のみを印刷するだけです
• リリース
  • パッケージ- パッケージを構築します（zip、deb、rpm、osに応じてWindowsインストーラー）
• その他
  • doc-ドキュメントのビルド（doxygenが利用可能な場合）
    • ドキュメントはbuild_dir/doc/doc/index.htmlにあります
    • インストールパッケージの一部にしたい場合は、 doc/CMakeLists.txtの最後にあるuncommentセクション
  • フォーマット- すべてのソースファイルでClang-Formatを実行します（プロジェクトのルートディレクトリのClang-Formatが使用されています）
  • GDB -GDBでターゲット実行可能ファイルを実行します（忍者からは機能しません、GDBが必要です）
• 静的分析
  • Tidy-すべてのソースで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ゴールドリンカーとリンクするかどうか。

ライセンス

Copyright（c）2019 Kracejic

このソフトウェアと関連するドキュメントファイル（「ソフトウェア」）のコピーを入手して、制限なしにソフトウェアを扱うために、このソフトウェアを制限する権利を含め、ソフトウェアのコピーをコピー、変更、公開、配布、販売する、ソフトウェアのコピーを許可する人を許可する人を許可することを含めて、許可が無料で許可されます。

上記の著作権通知とこの許可通知は、ソフトウェアのすべてのコピーまたはかなりの部分に含まれるものとします。

このソフトウェアは、商品性、特定の目的への適合性、および非侵害の保証を含むがこれらに限定されない、明示的または黙示的なものを保証することなく、「現状のまま」提供されます。いかなる場合でも、著者または著作権所有者は、契約、不法行為、またはその他の訴訟、ソフトウェアまたはソフトウェアの使用またはその他の取引に関連する、またはその他の契約、またはその他の請求、またはその他の責任について責任を負いません。