From 3ac8a4eeca3febf73e5dcd2cdd26e4b1dda7b64d Mon Sep 17 00:00:00 2001 From: Matt Hellige Date: Fri, 7 Jun 2019 14:40:29 -0500 Subject: [PATCH] Add build instructions. --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 7e3c933..af0d98b 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,26 @@ without someone talking along with it. [1]: http://github.com/hellige/ccs [2]: http://hellige.github.io/ccs + +Building +-------- + +CCS is built with CMake. You can set the usual options to control your +compiler, build type, etc., but the crash course is: + + $ mkdir build + $ cd build + $ cmake .. + $ make + +You can run unit tests with pretty output using: + + $ make unittest + +CMake can install everything for you, but in any case the client-facing +headers are in the `api` directory. + + Syntax quick reference ----------------------