aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKimplul <kimi.h.kuparinen@gmail.com>2023-05-15 21:52:09 +0300
committerGitHub <noreply@github.com>2023-05-15 21:52:09 +0300
commitde0dd03ef406606a56b22eb830eecc8430977c98 (patch)
treeac86dd427876642e2b7926c64edee9f8ccb5335f /README.md
parentc2819ba6c46c1e870d330eef82dda70fca85bbd8 (diff)
downloadgran-de0dd03ef406606a56b22eb830eecc8430977c98.tar.gz
gran-de0dd03ef406606a56b22eb830eecc8430977c98.zip
Create README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6bf8707
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# gran
+
+Gran is a toy granular full system simulator,
+taking heavy inspiration from [gem5](https://www.gem5.org/).
+
+Currently there are a couple example components, including
+`simple_mem` for atomic memory accesses, `simple_bus` for non-coherent
+atomic transfers between components and `simple_riscv32`, a simple
+rv32i processor.
+
+# Building
+
++ `make`
+
+Add `RELEASE=1` to enable optimizations.