https://github.com/gbmhunter/cpptemplate
A template repository to quick-start C++ development.
https://github.com/gbmhunter/cpptemplate
codecov coverage cplusplus cpp cpp14 example gtest jumpstart quickstart repository template travis-ci
Last synced: 2 months ago
JSON representation
A template repository to quick-start C++ development.
- Host: GitHub
- URL: https://github.com/gbmhunter/cpptemplate
- Owner: gbmhunter
- License: mit
- Created: 2017-11-27T21:05:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-20T18:18:38.000Z (about 6 years ago)
- Last Synced: 2025-03-30T03:51:12.096Z (3 months ago)
- Topics: codecov, coverage, cplusplus, cpp, cpp14, example, gtest, jumpstart, quickstart, repository, template, travis-ci
- Language: Shell
- Homepage:
- Size: 179 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
===========
CppTemplate
===========
-----------------------------------------------------------------------------------------
A template repository to quick-start C++ development.
-----------------------------------------------------------------------------------------
.. image:: https://travis-ci.org/gbmhunter/CppTemplate.svg?branch=master
:target: https://travis-ci.org/gbmhunter/CppTemplate
.. image:: https://codecov.io/gh/gbmhunter/CppTemplate/branch/master/graph/badge.svg
:target: https://codecov.io/gh/gbmhunter/CppTemplate
--------
Features
--------
- C++14 template/example project with example header files and source files
- CMake-based build system
- Automatic build script in ./tools/
- gtest-based unit tests (and a make target to automatically build/run unit tests)
- CI functionality using TravisCI (with sudo available on Ubuntu 14.04)
- Semantic versioning and keepachangelog.com-based Changelog format
- Doyxgen support (example :code:`doxygen.conf` file provided) coupled with GitHub pages support, see https://gbmhunter.github.io/CppTemplate/index.html for example documentation.
- Code coverage support using lcov and https://codecov.io. Code coverage is only generated for the files which matter, the source code in :code:`src/` and :code:`include/` directories.
---------------
Automatic Build
---------------
.. code:: bash
~/CppTemplate$ ./tools/build.sh
------------
Manual Build
------------
.. code:: bash
~/CppTemplate$ mkdir build
~/CppTemplate$ cd build/
~/CppTemplate/build$ cmake ..
~/CppTemplate/build$ make
~/CppTemplate/build$ make run_unit_tests
~/CppTemplate/build$ sudo make install
-------------------------
To Generate Documentation
-------------------------
.. code:: bash
~/CppTemplate$ doxygen doxygen.conf