summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 18 insertions, 7 deletions
diff --git a/README.md b/README.md
index d797781..aa61af6 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,23 @@
-# RISC V[ECTOR] Assembler
+# rva
+
+This is an assembler for a custom ISA nicknamed "RISC V[ECTOR]". It takes in an assembly program syntactically similar to MIPS (see input) and outputs a list of binary numbers corresponding to the instructions. The output is compatible with the [RISC V[ECTOR]](https://github.com/bdunahu/RISC-V-ECTOR-) simulator.
## Dependencies
-- SBCL
-- ASDF
-- fiveam
-- clingon
+A common-lisp implementation (SBCL) and the following libraries are required to compile:
+
+- SBCL (tested with v2.5.2)
+- ASDF (tested with v3.3.7)
+- fiveam (tested with v3.3.7)
+- clingon (tested with v0.5.0-1.f2a730f)
+- trivia (tested with v0.1-0.8b406c3)
+
+## To run
+
+Run `make` to produce a binary file in `/bin/`. To run the unit tests, run `make test`. See the make file for further options.
+
+# About
-## To compile
+Created at the University of Massachusetts, Amherst
-make
+CS535 -- Computer Architecture and ISA Design \ No newline at end of file