aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGanesh Viswanathan <dev@genotrance.com>2019-01-23 19:40:01 -0600
committerGanesh Viswanathan <dev@genotrance.com>2019-01-23 19:40:01 -0600
commit2cec3015edb78bbaf96bf8304ef7e4697ddb1a37 (patch)
treeae08930e8a81194e29108105c3aff5eb078e78ac /README.md
parent46f7940f30ca7ef41dfcb01c09c72ce21dc47b89 (diff)
downloadnimterop-2cec3015edb78bbaf96bf8304ef7e4697ddb1a37.tar.gz
nimterop-2cec3015edb78bbaf96bf8304ef7e4697ddb1a37.zip
Fix #56 - override and skip, html links
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 1 insertions, 29 deletions
diff --git a/README.md b/README.md
index 07a6ec5..b262905 100644
--- a/README.md
+++ b/README.md
@@ -49,35 +49,7 @@ 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 `--help` flag provides more details.
-__Documentation__
-
-Documentation can be found [here](https://genotrance.github.io/nimterop/cimport.html).
-
-`cDebug()` - enable debug messages
-
-`cDisableCaching()` - disable caching of generated Nim content from `cImport()`
-
-`cDefine("XXX")` - `#define` an identifer that is forwarded to the C/C++ compiler using `{.passC: "-DXXX".}`
-
-`cIncludeDir("XXX")` - add an include directory that is forwarded to the C/C++ compiler using `{.passC: "-IXXX".}`
-
-`cImport("header.h")` - Import all supported definitions from specified header file. Generated content is cached in `nimcache` until `header.h` changes
-
-`cImport("header.h", recurse=true)` - import all supported definitions from header file and #includes
-
-`cCompile("file.c")` - compile C/C++ implementation into binary
-
-`cCompile("path/to/*.c")` - compile in all files matching wildcard
-
-`cCompile("path/to/dir", "cpp")` - compile in all C++ files found recursively
-
-`cAddSearchDir("XXX")` - add directory XXX to the search path used in calls to `cSearchPath()`
-
-`cAddStdDir("XXX")` - add standard "c" [default] or "cpp" include paths to search path used in calls to `cSearchPath()`
-
-`cSearchPath("header.h")` - return a file or directory found in search path configured using `cSearchPath()` - can be used in `cCompile()`, `cIncludeDir()` and `cImport()` calls
-
-`gitPull()` - pull a git repository prior to C/C++ interop
+Detailed documentation is available for [cimport](https://genotrance.github.io/nimterop/cimport.html) and [git](https://genotrance.github.io/nimterop/git.html).
__Implementation Details__