summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0fcc98e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# z80emu
+
+This repository contains a bare bones implementation of a Z80 emulator (written in Typescript), supporting up to 150+ basic opcodes. It is intended to be an educational project to show how one would approach simulating the behaviour of an 8-bit microprocessor.
+
+The simulator interface steps through a compiled binary and dumps the contents of each Z80 register after each fetch, decode, execute instruction cycle to the console.
+
+Z80 assembly programs are inteded to be compiled with [z80asm](https://www.nongnu.org/z80asm/)
+
+Files:
+<br/>
+* **z80.ts** - Core implementation. <br/>
+* **main.ts** - Simulator interface.