cpp project

Placa de caldera para proyectos C ++

Esta es una placa de caldera para proyectos C ++. Lo que obtienes:

• Fuentes, encabezados y platos principales separados en carpetas distintas
• Uso de CMake moderno para una compilación mucho más fácil
• Configuración para pruebas usando Doctor
• Pruebas continuas con acciones Travis-Ci, Appveyor y GitHub, con soporte para C ++ 17.
• Informes de cobertura de código, incluida la carga automática para Coverls.io y/o CodeCov.io
• Documentación de código con Doxygen

Estructura

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

Las fuentes van en los archivos de encabezado SRC/, en los programas principales de incluir/, y las pruebas van a las pruebas/(compiladas a unit_tests de forma predeterminada).

Si agrega un nuevo ejecutable, digamos app/hello.cpp , solo necesita agregar las siguientes dos líneas a 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).

Puede encontrar el código fuente de ejemplo que construye el ejecutable main en App/Main.cpp en la sección Build en cmakelists.txt. Si el ejecutable que hizo no usa la biblioteca en SRC/, solo se necesita la primera línea.

Edificio

Construya haciendo un directorio de compilación (es decir, build/ ), ejecute cmake en ese directorio y luego use make creación del objetivo deseado.

Ejemplo:

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

El archivo .gitignore es una copia del archivo Github C ++. Gitignore, con la adición de ignorar el directorio de compilación ( build/ ).

Servicios

Si el repositorio se activa con Travis-Ci, las pruebas unitarias se construirán y ejecutarán en cada confirmación. Lo mismo es cierto si el repositorio se activa con Appveyor.

Si el repositorio se activa con Coveralls/CodeCov, entonces la implementación en Travis también calculará la cobertura del código y cargará esto en Coveralls.io y/o CodeCov.io

Configuración

Usando la plantilla de Github

Haga clic en el botón Use this template para hacer un nuevo repositorio a partir de esta plantilla.

Desde la línea de comando

Al comenzar un nuevo proyecto, probablemente no desee la historia de este repositorio. Para comenzar de nuevo, puede usar el script de configuración de la siguiente manera:

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

El resultado es un nuevo repositorio de Git con una confirmación agregando todos los archivos de la placa de la caldera.