CSY/reowolf Files · README.md · Centrum Wiskunde & Informatica (CWI)

Files @ d23010006486

Branch filter:

Location: CSY/reowolf/README.md

d23010006486 676 B text/markdown Show Annotation Show as Raw Download as Raw

Christopher Esterhuyse

bugfix: increment round index on recovery to avoid mixing messages once we switch away from tcp. refactoring communication internals to simplify bookkeeping structures. more consts in tests to make them terser

# 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.
3. Running `cbindgen > reowolf.h` from the root will overwrite the header file. (WIP) This is only necessary to update it.