Stop having clibrojo as a default project, update docs

This commit is contained in:
Lucien Greathouse
2019-11-07 18:24:16 -08:00
parent dfb015acc2
commit 94e1501329
2 changed files with 16 additions and 2 deletions

View File

@@ -33,7 +33,6 @@ default-members = [
".",
"rojo-test",
"rojo-insta-ext",
"clibrojo",
]
[lib]

View File

@@ -2,3 +2,18 @@
This is an experiment to expose a C API for Rojo that would be suitable for embedding it into an existing C/C++ application.
I'm hoping to expand it to drop the HTTP layer and communicate through a channel, which could make it feasible to embed into an existing Roblox IDE with minimal changes or additional code.
## Building
This project is currently not built by default and could break/disappear at any time.
```bash
cargo build -p clibrojo
```
On Windows, Cargo will generate a `clibrojo.dll` and associated `.lib` file. Link these into your project.
To generate the associated C header file to include in the project, use [cbindgen](https://github.com/eqrion/cbindgen):
```bash
cbindgen --crate clibrojo --output include/rojo.h
```