about summary refs log tree commit diff stats
path: root/subx/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'subx/Readme.md')
-rw-r--r--subx/Readme.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/subx/Readme.md b/subx/Readme.md
index 4a444b0a..5af4f750 100644
--- a/subx/Readme.md
+++ b/subx/Readme.md
@@ -1,3 +1,15 @@
+## The SubX VM
+
 Bytecode interpreter for a subset of the 32-bit x86 ISA.
 
-I'm currently building this over at https://github.com/tekknolagi/stackx/tree/ak
+To build:
+
+  ```
+  ./build
+  ```
+
+To run tests:
+
+  ```
+  ./subx
+  ```