diff --git a/README.md b/README.md index b805ce2..b23e06e 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,20 @@ Rust bindings to [Lean 4](https://github.com/leanprover/lean4)'s C API -Functions and comments manually translated from those in the [`lean.h` header](https://github.com/leanprover/lean4/blob/master/src/include/lean/lean.h) provided with Lean 4 \ No newline at end of file +Functions and comments manually translated from those in the [`lean.h` header](https://github.com/leanprover/lean4/blob/master/src/include/lean/lean.h) provided with Lean 4 + +## Dynamic Builds + +If you are using this package as part of a dynamic build - in particular if your `Cargo.toml` is configured with + +```toml +[lib] +crate-type = ["cdylib"] +``` + +then the `static` feature of this library (which is enabled by default) will need to be disabled. This can be done by configuring `lean-sys` as follows: + +```toml +[dependencies] +lean-sys = { version = "0.0.5", features = ["small_allocator"], default-features = false } +```