Skip to content

Commit

Permalink
Readme: Fix build instructions
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Jan Matyas committed Oct 21, 2024
1 parent bcd05b7 commit 5dc62af
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <rev>

git submodule update --init --recursive

cd build
make
```

Expand Down

0 comments on commit 5dc62af

Please sign in to comment.