cpp project

Assiette de chaudière pour les projets C ++

Il s'agit d'une plaque de chaudière pour les projets C ++. Ce que vous obtenez:

• Sources, en-têtes et plats séparés dans des dossiers distincts
• Utilisation de Cmake moderne pour une compilation beaucoup plus facile
• Configuration des tests en utilisant Doctst
• Test continu avec les actions Travis-Ci, Appveyor et GitHub, avec prise en charge de C ++ 17.
• Rapports de couverture de code, y compris le téléchargement automatique sur CoverAls.io et / ou Codecov.io
• Documentation du code avec doxygen

Structure

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

Les sources vont dans SRC /, les fichiers d'en-tête dans les programmes incluls /, principaux dans APP /, et les tests vont dans Tests / (compilé sur unit_tests par défaut).

Si vous ajoutez un nouvel exécutable, dites app/hello.cpp , il vous suffit d'ajouter les deux lignes suivantes à 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).

Vous pouvez trouver l'exemple de code source qui construit l'exécutable main dans app / main.cpp sous la section Build dans cmakelists.txt. Si l'exécutable que vous avez fabriqué n'utilise pas la bibliothèque dans SRC /, alors seule la première ligne est nécessaire.

Bâtiment

Build en créant un répertoire de construction (c'est-à-dire build/ ), exécutez cmake dans ce Dir, puis utilisez make pour construire la cible souhaitée.

Exemple:

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

Le fichier .gitignore est une copie du fichier GitHub C ++. Gitignore, avec l'ajout d'ignorance du répertoire de build ( build/ ).

Services

Si le référentiel est activé avec Travis-CI, les tests unitaires seront construits et exécutés sur chaque engagement. Il en va de même si le référentiel est activé avec AppVeyor.

Si le référentiel est activé avec CoverAlls / CodeCov, le déploiement à Travis calculera également la couverture du code et le téléchargera sur CoverAlS.io et / ou Codecov.io

Installation

Utilisation du modèle GitHub

Cliquez sur le bouton Use this template pour faire un nouveau référentiel à partir de ce modèle.

De la ligne de commande

Lorsque vous démarrez un nouveau projet, vous ne voulez probablement pas l'histoire de ce référentiel. Pour démarrer frais, vous pouvez utiliser le script de configuration comme suit:

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

Le résultat est un nouveau référentiel GIT avec un engagement en ajoutant tous les fichiers de la plaque de chaudière.