C++ Versionable Template

A C++ Template Project with Versioning Feature

Table of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
  • Makefile
• License

About The Project

A C++ Template Project with Versioning Feature

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Linux-based Operating System (for example, Ubuntu)
• Git

Installation

1. Open a terminal
2. Clone the Cpp Versionable Template

git clone https://github.com/IEEEIHUSerres/CppVersionableTemplate.git

3. Open the Cpp Versionable Template project

cd CppVersionableTemplate

4. Make a new build (dev build)

make new-build

5. Make a new release (production build)

make new-release

Makefile

Our Makefile contains 8 targets

• all (default), Makes a new build (dev build)
• new-build, Makes a new build (dev build)
• new-release, Makes a new release (production build)
• build, Makes a build without version changes (if it's already compiled, this does nothing)
• rebuild, Makes a build without version changes (if it's already compiled, this will remove the previous build)
• clean, Removes the previous build
• increment-build, Increments the build by one (example, 1->2, 5->6, etc)
• increment-version, Increments the version by one (example, 1->2, 5->6, etc)

License

Distributed under the Mozilla Public License Version 2.0. See LICENSE for more information.