aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoey Yakimowich-Payne <jyapayne@gmail.com>2018-07-09 09:21:14 +0900
committerJoey Yakimowich-Payne <jyapayne@gmail.com>2018-07-09 09:21:14 +0900
commit9c41b5a17644726ff982b65e2740f2cc3e57c54a (patch)
treed0203fdbb0e71ce907c617a22008085a02ec439a
parent17e54d3b8786422c8643cbe2f405f30ef324ed38 (diff)
downloadnimgen-9c41b5a17644726ff982b65e2740f2cc3e57c54a.tar.gz
nimgen-9c41b5a17644726ff982b65e2740f2cc3e57c54a.zip
Add better example to readme for env vars
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index f74950b..78ad979 100644
--- a/README.md
+++ b/README.md
@@ -30,13 +30,16 @@ __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:
+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 `$` or `${}` around the environment variable name. In addition, the `output` var from the n.global section is available as ${output}. For example:
[n.global]
+ c_compiler="$CC"
+ cpp_compiler="${CPP}-arm"
output="src/path"
[n.include]
"${output}/library/include"
+ "${MY_INCLUDE_PATH}/include"
To see examples of nimgen in action check out the following wrappers:-
* Link with a dynamic library