aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2018-09-29 15:03:24 +0200
committerdec05eba <dec05eba@protonmail.com>2020-07-06 07:39:33 +0200
commita5eeb97292ed084d0da3a02d7057d6f72219e6b9 (patch)
treed6ea0e590b4be964bf1967f2eee60006ff1dbb53 /README.md
parent9f3f366deec411675cc21c2fceaa7ac090d03a4c (diff)
Fix TODO: Move include_dirs & ignore_dirs under config
Merge duplicate parsing code into one function
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 7 insertions, 13 deletions
diff --git a/README.md b/README.md
index 59560d7..d59b322 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@ For easiest usage of sibs under windows, add msvc subdirectory to PATH environme
with the only missing software being cmake.
Dependencies that are required to build sibs from source are:
-`libcurl, libarchive, libgit2`
+`libcurl, libarchive, libgit2, curl`
`Ninja (build system)` needs to be installed on the system to be able to build projects. CMake can be required for some projects that uses cmake files to build project instead of sibs.
# IDE support
@@ -45,8 +45,6 @@ type = "library"
version = "0.1.0"
platforms = ["linux32", "linux64", "win32", "win64"]
authors = ["DEC05EBA <0xdec05eba@gmail.com>"]
-include_dirs = ["include"]
-ignore_dirs = ["examples"]
[dependencies]
catch2 = "0.1.0"
@@ -69,6 +67,8 @@ BOOST_COMPILE_STATIC = "1"
BOOST_COMPILE_DYNAMIC = "1"
[config]
+include_dirs = ["include"]
+ignore_dirs = ["examples"]
expose_include_dirs = ["include"]
[config.win32.static.debug]
@@ -93,25 +93,15 @@ args = ["ENTITYX_BUILD_SHARED=1"]
## package
### name
Required
-
### type
Required. Should be one of: "executable", "static", "dynamic", "library"
-
### version
Required. Version string has to be in the format of "xxx.yyy.zzz" where xxx is major, yyy is minor and zzz is patch
-
### platforms
Required. A list of platforms the package supports. Can contain the following values: "any", "linux32", "linux64", "win32", "win64".
If platforms contains "any", then other there is no need to specify other platforms
-
### authors
Optional. A list of authors
-
-### include_dirs
-Optional. A list of directories which should be specified as global include directories when compiling. This means that instead of using relative paths to header files, you can include the directory with headers and then you only have to specify the header name when using #include
-
-### 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. 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.
@@ -135,6 +125,10 @@ Works like \[define], but these definitions are only used when building static p
## define.dynamic
Works like \[define], but these definitions are only used when building dynamic project. If a definition with the same exists in \[define], then it's overwritten
## config
+### include_dirs
+Optional. A list of directories which should be specified as global include directories when compiling. This means that instead of using relative paths to header files, you can include the directory with headers and then you only have to specify the header name when using #include
+### 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
### 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
## config.*