aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2018-01-03 22:59:17 +0100
committerdec05eba <dec05eba@protonmail.com>2018-01-03 22:59:22 +0100
commite862bb76a2f4c9c293fe2638c7fb034de2af709c (patch)
tree01e8b246da70c6c7308364570899c5296c2404ad /README.md
parent8dd3fbf6211de0e2f274af47c6fe5a73334f0bb0 (diff)
Add custom define option
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 08cd27a..cd06dc6 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,9 @@ ignore_dirs = ["examples"]
catch2 = "0.1.0"
xxhash = "0.1.0"
+[define]
+BOOST_ASIO_SEPERATE_COMPILATION = "1"
+
[config]
expose_include_dirs = ["include"]
@@ -74,11 +77,13 @@ Optional. A list of directories which should be specified as global include dire
### ignore_dirs
Optional. A list of directories to ignore. This means that if the ignored directory contains source files, then they wont be included in the build
## dependencies
-Optional. Dependencies are specified in name-value pairs where the name is the name of the dependency, which should match the dependency name under the packages name specified in its project.conf file.
+Optional. A list of dependencies which are specified in name-value pairs where the name is the name of the dependency, which should match the dependency name under the packages name specified in its project.conf file.
Currently, the value is the version and has to be an exact match for the package version, which is specified in the dependencies project.conf file.
This will later change and you should be able to choose minimum version and range of versions.
Dependencies are automatically choosen from system (linux, mac) or if no package manager exists, then it's download from github
+## define
+Optional. A list of definitions which are specified in name-value pairs where the name is the preprocessor to define (in c: #define name value)
## config
### expose_include_dirs
Optional. A list of directories which contains (header) files which should be exposed to dependencies as directories to include globally. This means that dependencies can include (header) files from the dependency without specifying path to the dependency