diff --git a/README.md b/README.md index 7014917d77d9dceecefbfc3e70c78d1eedce037f..f18a11eecd15e0af40fc59a9a19e9b76bfd55497 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ -# Reowolf Implementation +# Reowolf 1.0 Implementation ## 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. + - 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. -1. Install the Rust toolchain, using Rustup. See https://rustup.rs/ for further instructions. -2. Run `cargo test` to download dependencies, compile the project, and run the tests. - +## Structure +- The user-facing API is visible in src/runtime/connector.rs