aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoey Yakimowich-Payne <jyapayne@gmail.com>2018-06-20 14:04:14 +0900
committerJoey Yakimowich-Payne <jyapayne@gmail.com>2018-07-08 13:05:36 +0900
commit76020e8f219bda1af3f7e1bc7974ffb1d6b2a6df (patch)
tree59875017d1f4cf43532b0c416eaf5ff2f0973fcd
parent467d0c4eae83d49e677bc03f8c3300a71bd9fcf1 (diff)
downloadnimgen-76020e8f219bda1af3f7e1bc7974ffb1d6b2a6df.tar.gz
nimgen-76020e8f219bda1af3f7e1bc7974ffb1d6b2a6df.zip
Add env vars to readme
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 765b6da..f74950b 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,14 @@ __Capabilities & Limitations__
Nimgen supports compiling in C/C++ sources and static libraries as well as loading in dynamic libraries.
+Environment variables are supported via Nim's string interpolation `%` symbol imported from the `strutils` module. Simply use double quotes to enclose any value and put `${}` around the environment variable name. In addition, the `output` var from the n.global section is available as ${output}. For example:
+
+ [n.global]
+ output="src/path"
+
+ [n.include]
+ "${output}/library/include"
+
To see examples of nimgen in action check out the following wrappers:-
* Link with a dynamic library
* [nimbass](https://github.com/genotrance/nimbass) - BASS audio wrapper: [docs](http://nimgen.genotrance.com/nimbass)