cpp project

C ++プロジェクト用のボイラープレート

これは、C ++プロジェクト用のボイラープレートです。あなたが得るもの：

• ソース、ヘッダー、メインは、異なるフォルダーで区切られています
• コンパイルをはるかに簡単にするために、最新のCmakeを使用します
• Doctestを使用したテストのセットアップ
• C ++ 17のサポートを伴うTravis-CI、Appvey、GitHubアクションによる継続的なテスト。
• 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/、mainプログラムのヘッダーファイルに移動し、テストはテスト/（デフォルトでunit_testsにコンパイルされます）になります。

新しい実行可能ファイル（ app/hello.cppなど）を追加する場合は、次の2行を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

その結果、ボイラープレートからすべてのファイルを追加する1つのコミットで、新鮮なGitリポジトリができます。