README.md

C++ Project Generator

A Yeoman generator for C++ projects.

Feature	Dependency	Version
Source Control	Git	2.13.3
Build & Packaging	CMake	2.8.12
Unit Testing	GoogleTest	1.8.0
Code Coverage	Lcov / Gcov	1.13
Documentation	Doxygen	1.8.13

Dependencies

The following tools are required:

npm

https://www.npmjs.com/

Yeoman

npm install -g yo

Install

To install the generator:

npm install generator-cpp

Setup

Project

To interactively setup a project:

yo cpp

To manually setup a project:

yo cpp --name "C++ Project" --author "Bob Marley" --email "[email protected]"

Available options are:

• --name "C++ Project"
• --author "Bob Marley"
• --email "[email protected]"
• --coverage

To automatically setup a project:

yo cpp --auto

Note that automatic and manual modes can be used together:

yo cpp --auto --name "C++ Project" --coverage

Class

To interactively add a class:

yo cpp:class

To manually add a class:

yo cpp:class MyClass

To automatically add a class:

yo cpp:class --auto

Other

To display help:

yo cpp --help

Build

Both CMake (recommended) and Autoconf syntaxes are supported:

mkdir build && cd build
cmake ..
make

or...

./configure
make

To run the tests:

make test

To run the code coverage analysis:

make coverage

To generate the documentation:

make docs

To install / uninstall:

make install
make uninstall

Credits

Big thanks to:

• generator-cpp-suite
• Yet Another Cpp Template Generator
• CONTRIBUTING
• CodeCoverage.cmake
• GetGitRevisionDescription.cmake
• UninstallTarget.cmake
• doxygen-bootstrapped