cpp project

Kesselplatte für C ++ - Projekte

Dies ist eine Kesselplatte für C ++ - Projekte. Was du bekommst:

• Quellen, Header und Netze, die in verschiedenen Ordnern getrennt sind
• Verwendung von modernen CMake für viel einfacheres Kompilieren
• Setup für Tests mit Doctest
• Kontinuierliche Tests mit Travis-CI-, Appveyor- und GitHub-Aktionen mit Unterstützung von C ++ 17.
• Code -Abdeckungsberichte, einschließlich automatischem Hochladen auf Coveralls.io und/oder codecov.io
• Codedokumentation mit Doxygen

Struktur

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

Die Quellen gehen in SRC/, Header -Dateien in einschließlich/, Hauptprogrammen in App/und Tests in Tests/(standardmäßig mit unit_tests kompiliert).

Wenn Sie eine neue ausführbare Datei hinzufügen, sagen Sie app/hello.cpp , müssen Sie CMakelists.txt nur die folgenden zwei Zeilen hinzufügen:

 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).

Sie finden den Beispielquellcode, der die main ausführbare Datei in App/Main.cpp im Abschnitt " Build in cmakelists.txt erstellt. Wenn die ausführbare Datei die Bibliothek in SRC/nicht verwendet, wird nur die erste Zeile benötigt.

Gebäude

Erstellen Sie durch Erstellen eines Build -Verzeichnisses (dh build/ ), führen Sie cmake in diesem Dir aus und verwenden Sie dann make Erstellen des gewünschten Ziels.

Beispiel:

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

Die .Gitignore -Datei ist eine Kopie der GitHub C ++. Gitignore -Datei mit dem Hinzufügen von Ignorieren des Build -Verzeichnisses ( build/ ).

Dienstleistungen

Wenn das Repository mit Travis-CI aktiviert wird, werden in jedem Commit in den Unit-Tests erstellt und durchgeführt. Das Gleiche gilt, wenn das Repository mit Appveyor aktiviert wird.

Wenn das Repository mit Coveralls/Codecov aktiviert wird, berechnet die Bereitstellung für Travis auch die Codeabdeckung und lädt diese auf Coveralls.io und/oder codecov.io hoch

Aufstellen

Verwenden der GitHub -Vorlage

Klicken Sie auf die Schaltfläche Use this template um ein neues Repository aus dieser Vorlage zu erstellen.

Aus Befehlszeile

Wenn Sie ein neues Projekt beginnen, möchten Sie wahrscheinlich nicht die Geschichte dieses Repositorys. Um frisch zu starten, können Sie das Setup -Skript wie folgt verwenden:

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

Das Ergebnis ist ein frisches Git -Repository mit einem Commit, der alle Dateien aus der Kesselplatte hinzufügt.