From e0e85e3113211ca41fee2579c4bd7ad4484f8c09 2020-07-28 10:04:20 From: Christopher Esterhuyse Date: 2020-07-28 10:04:20 Subject: [PATCH] updated readme --- diff --git a/README.md b/README.md index bfcaf0a74664e2bb5d22bcf9560c76b9a045590a..3a07b4e3665fd9bedf13e2baf9957c8e3776c4ee 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,14 @@ ## Compilation instructions 1. Install the latest stable Rust toolchain using Rustup. See https://rustup.rs/ for further instructions. -2. Run `cargo build --release` to download source dependencies, and compile the library with release-level optimizations. +1. Run `cargo build --release` to download source dependencies, and compile the library with release-level optimizations. - The resulting dylib can be found in target/release/, to be used with the header file reowolf.h. - Note: A list of immediate ancestor dependencies is visible in Cargo.toml. - Note: Run `cargo test --release` to run unit tests with release-level optimizations. + +## Build options +- `cargo build --release` produces the dylib object, exposing connector API for Rust. The C FFI is also included, and corresponds to the header file `reowolf.h`. +- `cargo build --release --features ffi_pseudo_socket_api` is only available on Linux, and also generates functions which comprise the pseudo-socket C FFI. + +## Notes 3. Running `cbindgen > reowolf.h` from the root will overwrite the header file. (WIP) This is only necessary to update it. \ No newline at end of file