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

Readme update

Browse source
This commit is contained in:
Ganesh Viswanathan 2020-03-15 22:23:22 -05:00
commit 077981c3a5
1 changed files with 25 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

48
README.md
View file

@ -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: The `toast` binary can also be used directly on the CLI:
``` ```
toast -h > toast -h
Usage: Usage:
main [optional-params] C/C++ source/header main [optional-params] C/C++ source/header
Options(opt-arg sep :|=|spc): Options:
-h, --help print this cligen-erated help -h, --help print this cligen-erated help
--help-syntax advanced: prepend,plurals,.. --help-syntax advanced: prepend,plurals,..
-k, --check bool false check generated wrapper with compiler -k, --check bool false check generated wrapper with compiler
-d, --debug bool false enable debug output -d, --debug bool false enable debug output
-D=, --defines= strings {} definitions to pass to preprocessor -D=, --defines= strings {} definitions to pass to preprocessor
-l=, --dynlib= string "" Import symbols from library in specified Nim string -l=, --dynlib= string "" import symbols from library in specified Nim string
-I=, --includeDirs= strings {} include directory to pass to preprocessor -f=, --feature= Features {} flags to enable experimental features
-m=, --mode= string "cpp" language parser: c or cpp -H, --includeHeader bool false add {.header.} pragma to wrapper
--nim= string "nim" use a particular Nim executable (default: $PATH/nim) -I=, --includeDirs= strings {} include directory to pass to preprocessor
-c, --nocomments bool false exclude top-level comments from output -m=, --mode= string "cpp" language parser: c or cpp
-o=, --output= string "" file to output content - default stdout --nim= string "nim" use a particular Nim executable (default: $PATH/nim)
-a, --past bool false print AST output -c, --nocomments bool false exclude top-level comments from output
-g, --pgrammar bool false print grammar -o=, --output= string "" file to output content - default stdout
--pluginSourcePath= string "" Nim file to build and load as a plugin -a, --past bool false print AST output
-n, --pnim bool false print Nim output -g, --pgrammar bool false print grammar
-E=, --prefix= strings {} Strip prefix from identifiers --pluginSourcePath= string "" nim file to build and load as a plugin
-p, --preprocess bool false run preprocessor on header -n, --pnim bool false print Nim output
-r, --recurse bool false process #include files -E=, --prefix= strings {} strip prefix from identifiers
-s, --stub bool false stub out undefined type references as objects -p, --preprocess bool false run preprocessor on header
-F=, --suffix= strings {} Strip suffix from identifiers -r, --recurse bool false process #include files
-O=, --symOverride= strings {} skip generating specified symbols -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__ __Implementation Details__