aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2018-01-26 09:22:55 +0100
committerdec05eba <dec05eba@protonmail.com>2018-01-26 09:23:03 +0100
commit6a7f6c7087b22c8df70b5d9df1e96c3f10a1fc86 (patch)
tree8f68a471ebf3cfbd3b9daf851d2cf412d95bf013
parent76a5e558e100d40fdf7177cf3e1ab982faa06b2b (diff)
Update readme with git dependency
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 7fb10a7..3077f22 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,7 @@ ignore_dirs = ["examples"]
[dependencies]
catch2 = "0.1.0"
xxhash = "0.1.0"
+cisb = { git = "https://github.com/DEC05EBA/cisb.git", branch = "master", revision = "c0c46a4" }
[lang.c]
version = "c11"
@@ -92,8 +93,10 @@ Optional. A list of directories to ignore. This means that if the ignored direct
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
+Dependencies are automatically choosen from system (linux, mac) or if no package manager exists, then it's download from an url (see https://github.com/DEC05EBA/sibs_packages).
+The dependency can also be a git project, in which case it will have the fields 'git' and optionally 'branch' and 'revision'.
+'git' specifies the url to the git repository, 'branch' is the git branch that should be used - defaults to 'master'.
+'revision' is the git revision to checkout, defaults to 'HEAD' (latest commit).
## lang.*
Optional. Allows you to change language specific configuration. \[lang.c] is for C and \[lang.cpp] is for C++.
Version specifies the language version, for \[lang.c] the version can be ansi, c89, c99 or c11 - if not set, c11 will be used.