cpp project

Pelat boiler untuk proyek C ++

Ini adalah pelat boiler untuk proyek C ++. Apa yang Anda dapatkan:

• Sumber, header, dan listrik yang dipisahkan dalam folder yang berbeda
• Penggunaan cmake modern untuk kompilasi yang lebih mudah
• Pengaturan untuk tes menggunakan Doctest
• Pengujian Berkelanjutan dengan Tindakan Travis-CI, Appveyor dan GitHub, dengan dukungan untuk C ++ 17.
• Laporan Cakupan Kode, termasuk unggahan otomatis ke coveralls.io dan/atau codecov.io
• Dokumentasi kode dengan doxygen

Struktur

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

Sumber masuk dalam src/, file header in include/, program utama dalam aplikasi/, dan tes masuk dalam tes/(dikompilasi ke unit_tests secara default).

Jika Anda menambahkan Executable baru, katakanlah app/hello.cpp , Anda hanya perlu menambahkan dua baris berikut ke 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).

Anda dapat menemukan contoh kode sumber yang membangun yang dapat dieksekusi main di app/main.cpp di bawah bagian Build di cmakelists.txt. Jika executable yang Anda buat tidak menggunakan perpustakaan di SRC/, maka hanya baris pertama yang diperlukan.

Bangunan

Bangun dengan membuat direktori build (yaitu build/ ), jalankan cmake di dir, dan kemudian gunakan make untuk membangun target yang diinginkan.

Contoh:

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

File .gitignore adalah salinan file GitHub C ++. Gitignore, dengan penambahan mengabaikan Direktori Build ( build/ ).

Layanan

Jika repositori diaktifkan dengan Travis-CI, maka tes unit akan dibangun dan dieksekusi pada setiap komit. Hal yang sama berlaku jika repositori diaktifkan dengan Appveyor.

Jika repositori diaktifkan dengan CoverAlls/Codecov, maka penyebaran ke Travis juga akan menghitung cakupan kode dan mengunggahnya ke CoverAlls.io dan/atau codecov.io

Pengaturan

Menggunakan Template GitHub

Klik tombol Use this template untuk membuat repositori baru dari template ini.

Dari baris perintah

Saat memulai proyek baru, Anda mungkin tidak ingin sejarah repositori ini. Untuk memulai segar, Anda dapat menggunakan skrip pengaturan sebagai berikut:

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

Hasilnya adalah repositori git baru dengan satu komit menambahkan semua file dari pelat boiler.