Skip to content

Commit

Permalink
Add minimal mention of Wasm/TS support in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mutagene committed Nov 18, 2023
1 parent f42b9d7 commit f8e36d2
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Djinni generator parses an interface definition file and generates:
- Objective-C++ code to convert between C++ and Objective-C
- Python and C code to convert between C++ and Python over CFFI
- C++/CLI code to convert between C++ and C#
- C++ code to convert between WebAssembly and TS/JS


## Installation
Expand Down Expand Up @@ -86,3 +87,5 @@ The code in this repository is in large portions copied from [dropbox/djinni](ht
- Jacob Potter
- Iulia Tamas
- Andrew Twyman

WebAssembly support is borrowed in large part from [snapchat/djinni](https://github.com/snapchat/djinni).
8 changes: 8 additions & 0 deletions docs/cli-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,14 @@ djinni \
| `--cppcli-namespace ...` | The namespace name to use for generated C++/CLI classes. |
| `--cppcli-include-cpp-prefix <prefix>` | The prefix for `#include` of the main C++ header files from C++/CLI files. |

### WebAssembly/TS/JS

| Argument | Description |
|----------------------------------------|----------------------------------------------------------------------------|
| `--wasm-out <out-folder>` | WebAssembly bridge code output folder |
| `--ts-out <out-folder>` | Path to the Typescript type definitions output folder |
| `--ts-module <module>` | Name of the module for the Typescript types. `module.ts` by default. |


### Yaml Generation

Expand Down

0 comments on commit f8e36d2

Please sign in to comment.