From 1f6ee990275f412d4cc84483051fd549710da634 Mon Sep 17 00:00:00 2001
From: dec05eba <dec05eba@protonmail.com>
Date: Mon, 1 Jan 2018 09:40:08 +0100
Subject: Add config parsing for cmake

cmake has not integrated yet, but it will parse...
Add test script to easily run tests
---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 7f43ccd..f328152 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,17 @@ lib = "windows/x86/static/release"
 
 [config.win64.static.debug]
 lib = "windows/x64/static/debug"
+
+# cmake building is currrently not implemented, but it is intended to work like this
+[cmake]
+dir = "."
+args = ["ENTITYX_RUN_BENCHMARKS=0"]
+
+[cmake.static]
+args = ["ENTITYX_BUILD_SHARED=0"]
+
+[cmake.dynamic]
+args = ["ENTITYX_BUILD_SHARED=1"]
 ```
 ## package
 ### name
@@ -75,3 +86,16 @@ Optional. The name is structured in the following way: config.platform.libraryTy
 where platform is any of the platforms specified under \[package] (or if package contains "any", then it can be any other platform). LibraryType is either "static" or "dynamic" - different configurations depending on if the package is included as a static or dynamic library by a dependant package. OptimizationLevel is either "debug" or "release", depending on which optimization level the "root" package was built with ("root" package is usually the project which is an executable)
 ### lib
 Optional. A directory which contains .lib or .dll files which should be included in dependant projects that uses this project
+## cmake
+Optional. Using this allows you to build cmake projects. If a project contains cmake in the project.conf file, then sibs wont build the project itself
+and will use cmake instead. Sibs will put the built executable and library files into the same location they would be if sibs build them,
+meaning you can have dependency to a cmake project from a sibs project and it will automatically use the dependency library files
+### dir
+Optional. Directory that contains CMakeLists.txt. If this is not specified, the project root will be used (same location where project.conf is located)
+### args
+Optional. List of arguments to cmake. The arguments should be in the same format as "-D" arguments (options) in cmake, except they should exclude "-D".
+Do not use CMAKE_BUILD_TYPE as sibs will automatically use it depending on the optimization level the user specifies when building project.
+## cmake.*
+Optional. The name is structured in the following way: config.libraryType 
+where libraryType is either "static" or "dynamic" - different configurations depending on if the package is included as a static or dynamic library by a dependant package.
+Args specified under \[cmake.static] or \[cmake.dynamic] are appended to the args specified under \[cmake]
-- 
cgit v1.2.3