aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGanesh Viswanathan <dev@genotrance.com>2020-03-15 22:23:22 -0500
committerGanesh Viswanathan <dev@genotrance.com>2020-03-15 22:23:22 -0500
commit077981c3a5e577029cf28bffc67648e73d4aafcc (patch)
tree98ba1cc0b22e8ca6dfb950c6ded7b4dd550275ec
parent4dd15aa7d7c2aae0e4d96e4ac0a4c1423afd396e (diff)
downloadnimterop-077981c3a5e577029cf28bffc67648e73d4aafcc.tar.gz
nimterop-077981c3a5e577029cf28bffc67648e73d4aafcc.zip
Readme update
-rw-r--r--README.md48
1 files changed, 25 insertions, 23 deletions
diff --git a/README.md b/README.md
index ca16293..b1fee44 100644
--- a/README.md
+++ b/README.md
@@ -90,31 +90,33 @@ Refer to the ```tests``` directory for examples on how the library can be used.
The `toast` binary can also be used directly on the CLI:
```
-toast -h
+> toast -h
Usage:
main [optional-params] C/C++ source/header
-Options(opt-arg sep :|=|spc):
- -h, --help print this cligen-erated help
- --help-syntax advanced: prepend,plurals,..
- -k, --check bool false check generated wrapper with compiler
- -d, --debug bool false enable debug output
- -D=, --defines= strings {} definitions to pass to preprocessor
- -l=, --dynlib= string "" Import symbols from library in specified Nim string
- -I=, --includeDirs= strings {} include directory to pass to preprocessor
- -m=, --mode= string "cpp" language parser: c or cpp
- --nim= string "nim" use a particular Nim executable (default: $PATH/nim)
- -c, --nocomments bool false exclude top-level comments from output
- -o=, --output= string "" file to output content - default stdout
- -a, --past bool false print AST output
- -g, --pgrammar bool false print grammar
- --pluginSourcePath= string "" Nim file to build and load as a plugin
- -n, --pnim bool false print Nim output
- -E=, --prefix= strings {} Strip prefix from identifiers
- -p, --preprocess bool false run preprocessor on header
- -r, --recurse bool false process #include files
- -s, --stub bool false stub out undefined type references as objects
- -F=, --suffix= strings {} Strip suffix from identifiers
- -O=, --symOverride= strings {} skip generating specified symbols
+Options:
+ -h, --help print this cligen-erated help
+ --help-syntax advanced: prepend,plurals,..
+ -k, --check bool false check generated wrapper with compiler
+ -d, --debug bool false enable debug output
+ -D=, --defines= strings {} definitions to pass to preprocessor
+ -l=, --dynlib= string "" import symbols from library in specified Nim string
+ -f=, --feature= Features {} flags to enable experimental features
+ -H, --includeHeader bool false add {.header.} pragma to wrapper
+ -I=, --includeDirs= strings {} include directory to pass to preprocessor
+ -m=, --mode= string "cpp" language parser: c or cpp
+ --nim= string "nim" use a particular Nim executable (default: $PATH/nim)
+ -c, --nocomments bool false exclude top-level comments from output
+ -o=, --output= string "" file to output content - default stdout
+ -a, --past bool false print AST output
+ -g, --pgrammar bool false print grammar
+ --pluginSourcePath= string "" nim file to build and load as a plugin
+ -n, --pnim bool false print Nim output
+ -E=, --prefix= strings {} strip prefix from identifiers
+ -p, --preprocess bool false run preprocessor on header
+ -r, --recurse bool false process #include files
+ -s, --stub bool false stub out undefined type references as objects
+ -F=, --suffix= strings {} strip suffix from identifiers
+ -O=, --symOverride= strings {} skip generating specified symbols
```
__Implementation Details__