aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGanesh Viswanathan <dev@genotrance.com>2017-12-04 14:26:20 -0600
committerGanesh Viswanathan <dev@genotrance.com>2017-12-04 14:26:20 -0600
commit27ea25b901787c2f4ac7b7534cc944f26a8dde6c (patch)
tree42e391726a76fa294659773a4533dd0c0d8a2337 /README.md
parent9bcabd23e3c542937e12b25aae94f6eb43ff75c4 (diff)
downloadnimgen-27ea25b901787c2f4ac7b7534cc944f26a8dde6c.tar.gz
nimgen-27ea25b901787c2f4ac7b7534cc944f26a8dde6c.zip
- Added support for wildcard file tasks
- Fixed issue in replacing - with _ in generated modules - Fixed inconsistent naming of flags and procs
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/README.md b/README.md
index ea57fa4..818f6c8 100644
--- a/README.md
+++ b/README.md
@@ -94,9 +94,9 @@ Multiple entries for the all following keys are possible by appending any .strin
```dynlib``` = dynamic library to load at runtime for generated .nim procs
-The following keys apply to library source code (before processing) and generated .nim files (after processing) and allow manipulating the files as required to enable successful wrapping.
+The following keys apply to library source code (before processing) and generated .nim files (after processing) and allow manipulating the files as required to enable successful wrapping. They are not propagated to #include files when ```recurse = true```.
-```create``` = create a file at exact location with contents specified
+```create``` = create a file at exact location with contents specified. File needs to be in the _[n.exclude]_ list in order to be created.
```search``` = search string providing context for following prepend/append/replace directives
@@ -106,6 +106,12 @@ The following keys apply to library source code (before processing) and generate
```replace``` = string value to replace search string in file
+_[n.wildcard]_
+
+File wildcards such as *.nim, ssl*.h, etc. can be used to perform tasks across a group of files. This is useful to define common operations such as global text replacements without having to specify an explicit section for every single file. These operations will be performed on every matching file that is defined as a _sourcefile_ or recursed files.
+
+```wildcard``` = pattern to match against. All keys following the wildcard declaration will apply to matched files
+
__Feedback__
Nimgen is a work in progress and any feedback or suggestions are welcome. It is hosted on [GitHub](https://github.com/genotrance/nimgen) with an MIT license so issues, forks and PRs are most appreciated.