From 76020e8f219bda1af3f7e1bc7974ffb1d6b2a6df Mon Sep 17 00:00:00 2001
From: Joey Yakimowich-Payne <jyapayne@gmail.com>
Date: Wed, 20 Jun 2018 14:04:14 +0900
Subject: Add env vars to readme

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

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)
-- 
cgit v1.2.3