Giter Site home page Giter Site logo

ghostdevhv / cpp-project Goto Github PK

View Code? Open in Web Editor NEW

This project forked from bsamseth/cpp-project

0.0 0.0 0.0 103 KB

Boiler plate for C++ projects, with CMake, Google Test, Travis CI and coverage reports.

License: MIT License

CMake 89.64% C++ 8.45% Shell 1.90%

cpp-project's Introduction

Build Status Coverage Status license Project Status: Active – The project has reached a stable, usable state and is being actively developed. Average time to resolve an issue Percentage of issues still open

Boiler plate for C++ projects

This is a boiler plate for C++ projects. What you get:

  • Sources, headers and mains separated in distinct folders
  • Access to Google Tests
  • Use of CMake for much easier compiling
  • Continuous testing with Travis-CI, with support for C++17.
  • Code coverage reports, including automatic upload to Coveralls.io
  • Code documentation with Doxygen

Demo of usage

Structure

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

Sources go in src/, header files in include/, main programs in app/, and tests go in tests/ (compiled to unit_tests.x by default).

If you add a new executable, say app/hello.cpp, you only need to add the following three lines to CMakeLists.txt:

add_executable(hello.x app/hello.cpp)   # Name of exec. and location of file.
add_dependencies(hello.x engine)        # engine is the library built from src/*.cpp
target_link_libraries(hello.x engine)   # Link the executable to the 'engine'.

You can find the example that builds the example in app/main.cpp under the Build section in CMakeLists.txt. If the executable you made does not use the library in src/, then only the first line is needed.

Building

Build by making a build directory (i.e. build/), run cmake in that dir, and then use make to build the desired target.

Example:

$ mkdir build && cd build
$ cmake .. -DCMAKE_BUILD_TYPE=[Debug | Coverage | Release]
$ make
$ ./main.x
$ make gtest     # Makes and runs the tests.
$ make coverage  # Generate a coverage report.
$ make doc       # Generate html documentation.

.gitignore

The .gitignore file is a copy of the Github C++.gitignore file, with the addition of ignoring the build directory (build/).

Services

If repository is activated with Travis-CI, then unit tests will be built and executed on each commit.

If repository is activated with Coveralls, then deployment to Travis will also calculate code coverage and upload this to Coveralls.io.

Setup

When starting a new project, you probably don't want the history of this repository. To start fresh you can use the setup script as follows:

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

The result is a fresh Git repository with one commit adding all files from the boiler plate.

cpp-project's People

Contributors

bsamseth avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.