diff --git a/README.md b/README.md index 37fbc9b2..ec0de2ed 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,31 @@ Configurable RISC-V Processor Wally is a 5-stage pipelined processor configurable to support all the standard RISC-V options, incluidng RV32/64, A, C, F, D, and M extensions, FENCE.I, and the various privileged modes and CSRs. It is written in SystemVerilog. It passes the RISC-V Arch Tests and Imperas tests. As of October 2021, it boots the first 10 million instructions of Buildroot Linux. +If you are new to using Linux and Github, follow the steps in the RISCV SoC Design textbook to: + + See Chapter 2 of draft book of how to install and compile tests. + + Download and install x2go - A.1 + Download and install VSCode - A.4.2 + Make sure you can log into Tera acceptly via x2go and via a terminal + Terminal on Mac, cmd on Windows, xterm on Linux + See A.1 about ssh -Y login from a terminal + Git started with Git configuration and authentication: B.1 + +Then follow Section 2.2.2 to clone the repo, source setup, make the tests and run regression + +$ cd +$ export RISCV=/opt/riscv +$ git clone --recurse-submodules https://github.com/davidharrishmc/riscv-wally +$ cd riscv-wally +$ source ./setup.sh +$ make +$ cd pipelined/regression +$ ./regression-wally (depends on having Questa installed) + +Add the following lines to your .bashrc or .bash_profile + +if [ -f ~/riscv-wally/setup.sh ]; then + source ~/riscv-wally/setup.sh +fi