Skip to content

Commit

Permalink
Differentiate between use cases for different installation options
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanielnrn authored Dec 30, 2024
1 parent 7cf1c1b commit d969b95
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/running-calyx/fud2/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit d969b95

Please sign in to comment.