From d969b9560be3b8826a72e06d84912213131432a9 Mon Sep 17 00:00:00 2001 From: Nathaniel Navarro Date: Mon, 30 Dec 2024 08:17:32 -0800 Subject: [PATCH] Differentiate between use cases for different installation options --- docs/running-calyx/fud2/index.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/running-calyx/fud2/index.md b/docs/running-calyx/fud2/index.md index 05be0eabf..e70a2d4bd 100644 --- a/docs/running-calyx/fud2/index.md +++ b/docs/running-calyx/fud2/index.md @@ -11,10 +11,12 @@ Until then, fud remains your first choice for all your build-related needs. ## Set Up -fud2 is a Rust tool, so you can build it along with everything else in this monorepo with `cargo build`. +If you would like to use `fud2` as is, and already have Calyx installed, you can `cargo install --path fud2` from this repository's root to automatically add the binary to your path. + +If you would like to work on development of `fud2` and/or keep up with the latest changes when you `git pull`, you can build it along with everything else in this monorepo with `cargo build`. You might then want to do something like ``ln -s `pwd`/target/debug/fud2 ~/.local/bin`` for easy access to the `fud2` binary. -If you already have Calyx installed you can `cargo install --path fud2` from this repository's root to automatically add the binary to your path. + fud2 depends on [Ninja][]. Install it using your OS package manager or by downloading a binary.