cpp project

Placa de caldeira para projetos C ++

Esta é uma placa de caldeira para projetos de C ++. O que você recebe:

• Fontes, cabeçalhos e rede separados em pastas distintas
• Uso de cmake moderno para compilar muito mais fácil
• Configuração para testes usando o Doctest
• Testes contínuos com ações Travis-CI, AppVeyor e GitHub, com suporte para C ++ 17.
• Relatórios de cobertura de código, incluindo upload automático para Coveralls.io e/ou codecov.io
• Código documentação com doxygen

Estrutura

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

As fontes vão em SRC/, arquivos de cabeçalho incluem/, os principais programas no aplicativo/e os testes são testados/(compilados em unit_tests por padrão).

Se você adicionar um novo executável, digamos app/hello.cpp , você só precisará adicionar as duas linhas a seguir ao 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).

Você pode encontrar o código -fonte de exemplo que cria o main executável no app/main.cpp na seção Build em cmakelists.txt. Se o executável que você fez não usar a biblioteca no SRC/, apenas a primeira linha será necessária.

Prédio

Construa criando um diretório de compilação (ou seja, build/ ), execute cmake nesse dir e depois use make para criar o alvo desejado.

Exemplo:

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

O arquivo .gitignore é uma cópia do arquivo github c ++. Gitignore, com a adição de ignorar o diretório de construção ( build/ ).

Serviços

Se o repositório for ativado com o Travis-CI, os testes de unidade serão construídos e executados em cada confirmação. O mesmo acontece se o repositório for ativado com o AppVeyor.

Se o repositório for ativado com Coveralls/CodeCov, a implantação para Travis também calculará a cobertura do código e o enviará para Coveralls.io e/ou codecov.io

Configurar

Usando o modelo do github

Clique no botão Use this template para criar um novo repositório a partir deste modelo.

Da linha de comando

Ao iniciar um novo projeto, você provavelmente não deseja o histórico deste repositório. Para começar de novo, você pode usar o script de configuração da seguinte forma:

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

O resultado é um novo repositório Git, com um compromisso adicionando todos os arquivos da placa da caldeira.