diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index fd7f126fd..508f69b25 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -26,6 +26,7 @@ - [Scripting](./running-calyx/fud2/scripts.md) - [Interfacing with Calyx RTL](./running-calyx/interfacing.md) - [The Calyx Interpreter](./running-calyx/interpreter.md) +- [The Calyx Profiler](./running-calyx/profiler.md) - [FIRRTL Backend](./running-calyx/firrtl.md) # Compiler Development Guide diff --git a/docs/running-calyx/profiler.md b/docs/running-calyx/profiler.md index d1c64d9c0..bc0307b59 100644 --- a/docs/running-calyx/profiler.md +++ b/docs/running-calyx/profiler.md @@ -1,4 +1,4 @@ -# Calyx Profiler +# The Calyx Profiler *Note: The profiler is still in development. If you have any suggestions, thoughts, or feedback, please let us know!* @@ -7,7 +7,7 @@ Profilers can help you analyze performance information to find places you can op ## Setup In order to run the profiler, you need: -- [fud2][] +- [fud2](./fud2/index.html) - The Python [`vcdvcd` library](https://github.com/cirosantilli/vcdvcd). Running `fud2 env init` should install this for you. - A clone of Brendan Gregg's Flamegraph repository: [https://github.com/brendangregg/FlameGraph](https://github.com/brendangregg/FlameGraph)