Skip to content

Commit

Permalink
fud2 docs (#1893)
Browse files Browse the repository at this point in the history
  • Loading branch information
rachitnigam authored Feb 4, 2024
1 parent 3fa1f68 commit f2ab934
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/running-calyx/fud2.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,19 @@ You might then want to do something like ``ln -s `pwd`/target/debug/fud2 ~/.loca
fud2 depends on [Ninja][].
Install it using your OS package manager or by downloading a binary.

Create a configuration file at `~/.config/fud2.toml`, using the path to your checkout of the Calyx git repository:
### Configuration

Run the following command to edit `fud2`'s configuration file (usually `~/.config/fud2.toml`):
```
fud edit-config
```

Add the following fields:
```toml
rsrc = ".../calyx/fud2/rsrc"
rsrc = "<path to calyx checkout>/fud2/rsrc"

[calyx]
base = ".../calyx"
base = "<path to calyx checkout>"
```

Now you're ready to use fud2.
Expand Down

0 comments on commit f2ab934

Please sign in to comment.