cleanCppProject

Cleancppproject

Ini adalah bingkai kosong untuk proyek di C ++. Seharusnya membantu memulai proyek baru tanpa banyak peduli tentang pengaturan proyek/membangun lingkungan.

Fitur

• Modern dan sederhana membuat skrip build, dibagi menjadi beberapa komponen untuk keterbacaan.
• Target waras dan sederhana untuk semuanya (lihat bagian target ).
• Skrip CPACK yang dapat menghasilkan DEB , RPM , pemasang Windows , aplikasi bundel , DMG dan berbagai paket terkompresi.
• Tes melalui ctest.
• Tes unit melalui tangkapan.
• Pembuatan Dokumentasi Melalui Doxygen (Code + Wiki + UML Diagram dengan GraphViz dan Planuml).
• Dukungan Analisis Statis (Clang-Tidy, CPPCHECK).
• Analisis Dinamis Pembantu melalui Sanitizers (lihat CMake/Sanitizers.CMake).
• Bekerja dengan distro Linux favorit Anda, Windows, dan MacOS.
• Contoh konfigurasi Gitlab CI dan Travis CI.
• Dukungan untuk Linker Emas untuk waktu tautan yang lebih cepat.
• Pembantu untuk menambahkan dependensi eksternal yang diunduh selama konfigurasi atau build.
  • Lihat external/CMakeLists.txt dan cmake/cleanCppExtension.cmake

Halaman penting

• Dokumen Desain
• Daftar Todos (hanya doxygen)
• Struktur Direktori Dasar
• Bagaimana mulai bekerja

TODO Lihat cara kerja TODO

Cara Mengubah Ini ke Proyek Baru Anda

 git clone https://github.com/kracejic/cleanCppProject.git yourNewProject
cd yourNewProject
mv .git .git-cleanCppProject
git init
git add .
git commit -m "first commit"

Lebih banyak tentang cara mulai bekerja.

Bagaimana cara menjaga tautannya dengan kami

Kami meningkatkan repo ini secara teratur, jika Anda ingin mendapatkan lebih banyak dari kami, cobalah untuk menarik repo utama.

 cd yourNewProject/ 
git pull --git-dir='.git-cleanCppProject'

Instruksi bangunan

Prasyarat

• Cmake 3.2 dan lebih baru
• Kompiler dengan dukungan untuk C ++ 14
• git - untuk mengunduh sumber daya eksternal
• Doxygen for docs ( graphviz untuk lebih banyak grafik di dokumen, plantuml untuk lebih banyak diagram UML , Plantuml membutuhkan java)
• perahu klang untuk analisis dan format statis
• cppcheck untuk analisis statis lainnya

Prasyarat di Linux

• Arch Linux: sudo pacman -S cmake g++ graphviz git clang clang-tools-extra cppcheck java-runtime-common cppcheck

  • unduh plantuml.jar dan miliki di suatu tempat di mana jalur menunjuk ke

• Ubuntu 16.04: sudo apt-get install cmake g++ graphviz plantuml git clang clang-tidy clang-format cppcheck

Prasyarat di Windows

Dua cara, yang diuji:

• berbasis msys2

  • Minimal: pacman -S cmake g++ git
  • Perangkat Lunak Tambahan pacman -S clang mingw-w64-x86_64-clang-tools-extra mingw-w64-x86_64-clang-analyzer doxygen
  • Untuk grafik dalam dokumentasi Instal GraphViz (ke c:Program FilesGraphviz , sehingga skrip dapat menemukannya) dan menambahkan subdirektori bin ke jalur , instal java (miliki direktori binnya di jalur ), unduh file jaruml plantuml dan miliki di jalur .

• Microsoft Visual Studio

  • Instal CMake
  • Instal git
  • Untuk fitur tambahan, instal dentang dengan alat, doxygen, graphviz, plantuml, java dan tambahkan ke jalur ( tidak diuji )

Prasyarat tentang MacOS

• MacOS Sierra brew install llvm doxygen cppcheck graphviz

Bangun di Linux & MacOS

Makefiles Standar:

 mkdir build ; cd build
cmake ..
make -j8

Ninja membangun dentang penyihir, membangun semua+doc dan instal ke folder dist:

 mkdir build ; cd build
cmake -GNinja -DCMAKE_CXX_COMPILER="clang++" ..
ninja all doc install

Rilis Build yang akan menginstal dirinya ke /usr setelah sudo make install

 mkdir build ; cd build
cmake .. -DCMAKE_INSTALL_PREFIX="/usr" -DCMAKE_BUILD_TYPE="Release"
make -j8 all
sudo make install

Bangun di jendela

Bangun di jendela menggunakan msys2 + ninja

Pada jendela Anda harus lebih suka ninja karena jauh lebih cepat daripada membuat (tetapi tidak memiliki warna di shell).

Dengan GCC:

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

Anda dapat menggunakan cmake -G "MSYS Makefiles" .. Jika Anda ingin menggunakan make.

Bangun di Windows Menggunakan Microsoft Visual Studio 14

Pertama, Anda mungkin ingin mengubah nama proyek di CMakeLists.txt utama. Cukup buka folder dengan proyek dan buat direktori baru dan buat file proyek dengan ini:

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

Dan sekarang Anda dapat membuka file .sln dengan Visual Studio. Anda perlu mengklik kanan pada target yang dapat dieksekusi dan ditetapkan sebagai proyek startup . Untuk benar -benar melihat jendela konsol yang ingin Anda lakukan mulai tanpa debugging , karena ketika dijalankan dalam mode debug saja, janda konsol ditutup terlalu cepat.

Target

Catatan: Ketersediaan beberapa target tergantung pada ketersediaan yang dapat dieksekusi tertentu (misalnya format dentang untuk target format )

• Membangun
  • semua (default jika tidak ada target disediakan)
  • membersihkan
  • Instal - Instal binari ke dalam cmake_install_prefix
  • ExexpleApp - Build ExexpleApp Binary
  • ExampleApp -Run - Bangun, instal, dan jalankan Binary ExampleApp (untuk kenyamanan Anda)
  • ExexpleApp -GDB - Bangun, instal, dan jalankan Binary ExampleApp di GDB (untuk kenyamanan Anda)
  • Jalankan - Alias ​​untuk ExampleApp -Run (agar tetap pendek)
• Pengujian
  • Periksa - Jalankan Whole Test Suite (lihat test/cmakelists.txt)
  • CheckVerbose - Jalankan Whole Test Suite (lihat test/cmakelists.txt), tetapi lebih banyak verbose
  • Unit - Bangun dan Jalankan Tes Unit saja (lihat test/cmakelists.txt)
  • Unitall - Sama seperti sebelumnya, hanya mencetak hasil tes unit yang berhasil
• Pelepasan
  • Paket - Membangun Paket (ZIP, DEB, RPM, Windows Installer tergantung pada OS)
• Aneka ragam
  • DOC - Bangun dokumentasi (jika doxygen tersedia)
    • Dokumen dapat ditemukan di build_dir/doc/doc/index.html
    • Jika Anda ingin mereka menjadi bagian dari Paket Instal, bagian Uncomment di akhir doc/CMakeLists.txt
  • Format -Jalankan format klang pada semua file sumber (.clat-format di direktori root suatu proyek digunakan)
  • GDB - Jalankan target yang dapat dieksekusi dengan GDB (tidak berfungsi dari ninja, membutuhkan GDB)
• Analisis statis
  • TIDY - Jalankan analisis statis dentang pada semua sumber
  • CPPCHECK - Hubungi CPPCHECK pada semua file (analisis statis lainnya)
• Luar
  • UPDATE - Perbarui semua sumber/proyek eksternal

Variabel cmake

• -DCMAKE_INSTALL_PREFIX - Lokasi untuk instalasi
• -DVERSION_HOST - Bangun nama mesin, lihat versi.h.in
• -DCMAKE_BUILD_TYPE - untuk jenis build
• -DMEASURE_ALL=ON/OFF - Ukur waktu semua kompilasi, paling baik digunakan dengan bangunan berulir tunggal. Membutuhkan perintah time (unix).
• -DUSE_GOLD_LINKER=ON/OFF - apakah akan menautkan dengan linker emas.

Lisensi

Hak Cipta (C) 2019 Kracejic

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Pemberitahuan hak cipta di atas dan pemberitahuan izin ini harus dimasukkan dalam semua salinan atau bagian substansial dari perangkat lunak.

Perangkat lunak ini disediakan "sebagaimana adanya", tanpa jaminan apa pun, tersurat maupun tersirat, termasuk tetapi tidak terbatas pada jaminan dapat diperjualbelikan, kebugaran untuk tujuan tertentu dan nonpringement. Dalam hal apa pun penulis atau pemegang hak cipta tidak akan bertanggung jawab atas klaim, kerusakan atau tanggung jawab lainnya, baik dalam tindakan kontrak, gugatan atau sebaliknya, timbul dari, di luar atau sehubungan dengan perangkat lunak atau penggunaan atau transaksi lain dalam perangkat lunak.