diff --git a/README.md b/README.md index 35f0ed7..127521e 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@ -# lean-ffi-experiment \ No newline at end of file +# lean-rust-ffi-experiments + +This repo exists to demonstrate FFI between lean and rust. + + +Take a look at the `justfile` in the repository root for operations that can be run +on this code. + + +Run: + +```bash +$ just run-rust +``` + +To build a Lean library, a Rust executable that links against that library, and run +the Rust executable. + +