Skip to content

Commit

Permalink
Add alternative fud2 installation instructions (#2383)
Browse files Browse the repository at this point in the history
The existing instructions did not work to add `fud2` to my path (locally
on macOS). FWICT `cargo install --path fud2` did. Maybe we also want to
get rid of the previous instructions? Not sure if they are still valid.
  • Loading branch information
nathanielnrn authored Dec 31, 2024
1 parent 5e8ff91 commit 23d466e
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/running-calyx/fud2/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ 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.

Alternatively, 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.

fud2 depends on [Ninja][].
Expand Down

0 comments on commit 23d466e

Please sign in to comment.