jyapayne/nimgenEx
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Move env var section in readme

Browse source
This commit is contained in:
Joey Yakimowich-Payne 2018-07-09 09:51:44 +09:00
commit 3b60a0e4b1
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -30,17 +30,6 @@ __Capabilities & Limitations__
Nimgen supports compiling in C/C++ sources and static libraries as well as loading in dynamic libraries. 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 `$` 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:- To see examples of nimgen in action check out the following wrappers:-
* Link with a dynamic library * Link with a dynamic library
* [nimbass](https://github.com/genotrance/nimbass) - BASS audio wrapper: [docs](http://nimgen.genotrance.com/nimbass) * [nimbass](https://github.com/genotrance/nimbass) - BASS audio wrapper: [docs](http://nimgen.genotrance.com/nimbass)
@ -76,6 +65,17 @@ Nimgen only supports the ```gcc``` preprocessor at this time. Support for detect
__Config file__ __Config file__
In all sections below, 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"
_[n.global]_ _[n.global]_
```output``` = name of the Nimble project once installed, also location to place generated .nim files ```output``` = name of the Nimble project once installed, also location to place generated .nim files