summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index d48ce02..85e2dd8 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,16 @@
-# Risc V[ECTOR]
+# RISC V[ECTOR]
-## Corresponding Assembler can be found here
-`https://github.com/bdunahu/rva`
+## Dependencies
+
+This is a ISA simulator for a mini-ISA including vector support.
-## dependencies
- cmake
- g++ (GCC) 11.4.0
- catch2 version 3.5.3
- Qt version 6.8.2
+- [RAM](https://github.com/bdunahu/ram) (a custom memory submodule)
+
+Additionally, see [rva](https://github.com/bdunahu/rva) for a custom assembler which generates a compatible binary.
## to compile
Generate the build directory with
@@ -18,8 +21,12 @@ then compile both the simulator and tests with
`cmake --build build`
+To develop, the following git option is useful to keep modules updated:
+
+`git config submodule.recurse true`
+
# about
-University of Massachusetts, Amherst
-CS535 -- Computer Architecture and ISA Design
+Created at the University of Massachusetts, Amherst
+CS535 -- Computer Architecture and ISA Design