From 530e983dea06f47c3fefdc6b3683ae32977eab34 Mon Sep 17 00:00:00 2001 From: Francois Best Date: Sat, 8 Oct 2016 02:36:24 +0200 Subject: [PATCH] Added contributing guidelines (wip). --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9270a8a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +## Requirements + +Requirements to build and run the unit tests: +- CMake 2.8 or later +- GCC / Clang with C++11 support + +## Setup + +Pull Google Test / Google Mock subrepository: +``` +$ git init submodules +``` + +Create build directory, run CMake, build and run unit tests: +``` +$ mkdir build && cd build +$ cmake .. +$ make +$ ctest --verbose +```