From 5dc62afdfb3062f3b7359ee7153f22e1b510246a Mon Sep 17 00:00:00 2001 From: Jan Matyas Date: Wed, 9 Oct 2024 08:39:48 +0200 Subject: [PATCH] Readme: Fix build instructions The Readme contained the old (pre-adoc) build instructions. Fix them to describe the current build process. Mention also the use of submodules, which are needed for the documentation to build. --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ac9037a0..5d70a802 100755 --- a/README.md +++ b/README.md @@ -9,8 +9,21 @@ You may be looking for one of the following pre-built PDFs: Build Instructions ------------------ -``` -sudo apt-get install git make python3 python3-sympy graphviz texlive-full +```bash +# Install docker and python3-sympy, if not installed already. + +# Pull the latest RISC-V Docs container image: +docker pull riscvintl/riscv-docs-base-container-image:latest + +git clone https://github.com/riscv/riscv-debug-spec.git +cd riscv-debug-spec + +# Optionally, check out a specific revision: +# git checkout + +git submodule update --init --recursive + +cd build make ```