chore: added readme

aryanA101a · Jan 19, 2024 · ff0d701 · ff0d701
1 parent b463f61
commit ff0d701
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# lulu
+A LC3 architecture based virtual machine written in GO.
+
+
+## Build
+`go build`
+
+
+## Usage
+1. **Flags**
+```
+  -h	help
+  -logfile string
+    	path of logfile
+  -v	logging
+  ```
+
+2. **Examples**  
+  `./lulu program.obj`       
+  `./lulu -v program.bin`
+
+
+## References
+1. https://www.jmeiners.com/lc3-vm
+2. Introduction to Computing Systems: From bits & gates to C/C++ & beyond by Yale N. Patt, Sanjay J. Patel
+