From 47d111d913cdc47b56dba9f0d78ac516dab1d99c Mon Sep 17 00:00:00 2001 From: Manuel Drehwald Date: Mon, 5 Aug 2024 15:27:18 -0700 Subject: [PATCH] update readme --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 062126c109d73..22ad3faf491a3 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,16 @@ rustup toolchain link enzyme build/host/stage1 rustup toolchain install nightly # enables -Z unstable-options ``` -You can then run an examples from our [docs](https://enzyme.mit.edu/index.fcgi/rust/usage/usage.html) using +You can then run examples from our [docs](https://enzyme.mit.edu/index.fcgi/rust/usage/usage.html): ```bash -cargo +enzyme run --release +cd .. +git clone git@github.com:EnzymeAD/rustbook.git +cd rustbook/samples +cargo +enzyme test reverse ``` +If you want to use Autodiff in your own projects, please always enable `lto="fat"` in your Cargo.toml +and use `cargo +enzyme` instead of `cargo` or `cargo +nightly`. ## Bug reporting Bugs are pretty much expected at this point of the development process.