From 4e05d518b4377c23d7492fb6186241c8832f8df3 Mon Sep 17 00:00:00 2001 From: Gianna Paulin Date: Fri, 28 Jul 2023 14:53:40 +0200 Subject: [PATCH] docs: Extend documentation with bender, banshee and spike dependency --- docs/ug/getting_started.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/ug/getting_started.md b/docs/ug/getting_started.md index de2487ae5e..3d28814d12 100644 --- a/docs/ug/getting_started.md +++ b/docs/ug/getting_started.md @@ -74,3 +74,32 @@ Install the required packages in the currently active virtual environment: ```shell pip install -r python-requirements.txt ``` + +## Dependencies + +This repository has a couple of tool dependencies: + +- Dependency management tool `bender`: + ```bash + # Bender tool + cargo install bender --version 0.23.2 + ``` +- Instruction-accurate simulator `banshee`: + ```bash + # Banshee + git clone git@github.com:pulp-platform/banshee.git --recurse-submodules + # install in normal mode + cargo install --path banshee -f + # or install Banshee with `debug` and `trace` enabled + cargo install --debug --path banshee -f + ``` +- Snitch-ISA-aware `spike-dasm` version: + ```bash + git clone https://github.com/huettern/riscv-isa-sim + cd riscv-isa-sim + mkdir build + cd build + ../configure + make spike-dasm + # TODO: add binary location to $PATH + ```