aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGanesh Viswanathan <dev@genotrance.com>2018-02-02 14:48:59 -0600
committerGanesh Viswanathan <dev@genotrance.com>2018-02-02 14:48:59 -0600
commit968e89f08e08c1b0d93a63869e49b08879c70c51 (patch)
treeda10f80f342f1728ab1b937b7670c3bd519c6a56 /README.md
parent9b25a6d1dbedc6a440e1ad091e5d4c908662f2fa (diff)
downloadnimgen-0.1.3.tar.gz
nimgen-0.1.3.zip
Added inlining in place of recursion, extract existing ZIP file without downloading, delete/create output directory error handlingv0.1.3
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index e70ff16..040be3f 100644
--- a/README.md
+++ b/README.md
@@ -74,6 +74,8 @@ The following keys can be used to prepare dependencies such as downloading ZIP f
```download``` = url to download to the output directory. ZIP files are automatically extracted. Files are not redownloaded if already present but re-extracted
+```extract``` = ZIP file to extract in case they are local and don't need to be downloaded. Path is relative to output directory.
+
```git``` = url of Git repository to clone. Full repo is pulled so gitremote + gitsparse is preferable. Resets to HEAD if already present
```gitremote``` = url of Git repository to partially checkout. Use with gitsparse to pull only files and dirs of interest
@@ -94,6 +96,8 @@ The following keys apply to library source code and help with generating the .ni
```recurse``` = find #include files and process them [default: false]
+```inline``` = include #include files into file being processed, alternative method to processing each header file separately with recurse. Multiple source files will get combined into the same .nim output files [default: false]
+
```preprocess``` = run preprocessor (gcc -E) on file to remove #defines, etc. [default: false] - this is especially useful when c2nim doesn't support complex preprocessor usage
```ctags``` = run ctags on file to filter out function definitions [default: false] - this requires the ctags executable and is an alternative to filter out preprocessor complexity