Skip to content

Latest commit

 

History

History
61 lines (47 loc) · 1.24 KB

clone_and_build.md

File metadata and controls

61 lines (47 loc) · 1.24 KB

Clone and Build the Repo

Up to Documentation.

Clone the Repo

The repo URL is: https://github.com/zlatko-michailov/abc.git.

mkdir abc
git clone https://github.com/zlatko-michailov/abc.git abc
cd abc

Choose a Branch

master

master is the "stable" branch. This is the branch from where releases are cut. Documentation reflects this branch.

This is the only branch that is tagged.

git checkout master

dev

dev is the "beta" branch. This is the branch where the next big feature is developed. When that feature is ready, this branch gets merged into master.

git checkout dev

Build

Note: The library itself has nothing to build - it is a header-only library. What is being built is tests and samples.

To build with default options:

make

The first thing the build prints is the values of configurable variables. You can pass in custom values if needed. For instance, to build with Clang:

make CPP=clang++

That will build the tests and the samples. It will create a release.

Finally, it will run the tests. Each individual test as well as the summary at the end should show PASS.

All artifacts are generated in the out subfolder. To see what is there:

ls -l out