You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
…or it will be eventually, we hope!
We're building a modern, navigable, one-page-per-instruction reference for the RISC-V ISA based on on the RISC-V Unified Database (UDB).
It's a static website generated using Eleventy.
While the official RISC-V reference materials are comprehensive, they are hard to navigate.
The details for each instruction are spread across multiple sections.
Especially in an educational context, it can be cumbersome to find all the information you need about any specific instruction.
The idea in this reference is to generate one page per instruction, including things like the mnemonics and assembly syntax; the instruction encoding; some natural-language documentation; and so on.
Setup Instructions
This project uses Node.js and npm, so install those first.
Get the source code:
git clone [email protected]:cucapra/rvref.git
cd rvref
#project dependencies
npm install @11ty/eleventy --save-dev
npm install
git submodule update --init --recursive #adds the risc-unified-db submodule
npm run build #to generate static html files in _site
npm run serve #see site layout w/ dev server http://localhost:8080
git submodule update --init
git clone [email protected]:cucapra/rvref.git
cd rvref
git submodule update --init
That last step clones the riscv-unified-db repository as a submodule.
Notice that we don't use the --recursive flag; the UDB repository has some large submodules of its own that we don't need for this project.
Then, install the Node dependencies and build the static HTML files:
0 commit comments