From 7ef78b182192a353456be3dfa9f4a7a0c5f8da84 Mon Sep 17 00:00:00 2001 From: calebmkim <55243755+calebmkim@users.noreply.github.com> Date: Mon, 29 Apr 2024 13:46:26 -0400 Subject: [PATCH] update docs to note dependency (#2029) --- docs/intro.md | 3 +++ docs/running-calyx/fud/index.md | 2 ++ 2 files changed, 5 insertions(+) diff --git a/docs/intro.md b/docs/intro.md index fee8d75264..78c7e73c43 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -84,6 +84,9 @@ tests. [The Calyx driver](./running-calyx/fud) wraps the various compiler frontends and backends to simplify running Calyx programs. +`fud` currently has a dependency on [calyx-py](builder/calyx-py.md), which you need to install first. + + Install [Flit][]: ``` pip3 install flit diff --git a/docs/running-calyx/fud/index.md b/docs/running-calyx/fud/index.md index 1496841257..7df9544d5c 100644 --- a/docs/running-calyx/fud/index.md +++ b/docs/running-calyx/fud/index.md @@ -15,6 +15,8 @@ The source for fud is [here](https://github.com/calyxir/calyx/tree/master/fud). ## Installation > Fud requires Python 3.9 or higher to work correctly. +`fud` currently has a dependency on [calyx-py](builder/calyx-py.md), which you need to install first. + You need [Flit](https://flit.readthedocs.io/en/latest/) to install `fud`. Install it with `pip3 install flit`. You can then install `fud` with