diff --git a/Cargo.toml b/Cargo.toml index eb234dfa..7ced4938 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -33,7 +33,6 @@ default-members = [ ".", "rojo-test", "rojo-insta-ext", - "clibrojo", ] [lib] diff --git a/clibrojo/README.md b/clibrojo/README.md index 3c315c55..d8821ed9 100644 --- a/clibrojo/README.md +++ b/clibrojo/README.md @@ -1,4 +1,19 @@ # Rojo as a C Library 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. \ No newline at end of file +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 +``` \ No newline at end of file