From 05c74beebad6bf8a43296adc32a72fa04ce79d76 Mon Sep 17 00:00:00 2001
From: velllu <91963404+velllu@users.noreply.github.com>
Date: Mon, 11 Sep 2023 22:39:30 +0200
Subject: [PATCH] Added `README.md`

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5a7b68a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# <center>GameMan</center>
+> <br>
+> <center>The GameBoy emulator that does not play around™️</center>
+> <br>
+<pre></pre>
+
+# What can the emulator actually run?
+I am at a *very* early stage, this emulator will **not** run *any* game.  
+Here's a list of things I need to implement
+
+- [-] GPU
+    - [x] Barebones and graphicless implementation
+    - [ ] Background rendering
+    - [ ] Window rendering
+    - [ ] Sprite rendering
+- [ ] Input Handling
+- [ ] GameBoy Color support
+- [ ] SPU (Sound), I have yet to research this
+
+# What makes this emulator different?
+- It's **embeddable**, you can embed this into any UI framework, gtk, iced etc. This is not actually an emulator per se, it's the "backend", the "frontend" is up to you to implement, altough I will probably make one myself. As of now, a simple frontend that prints register values is available by running `cargo run --example terminal -- /path/to/rom.gb`.
+- It will *probably* be **embedded** as well in the future, meaning you will be able to run this on a microcontroller
+- Focused on **clean code**, this emulator's focus is neither speed or accuracy, if I delivered on this front is up to you, feel free to open an issue or a pull request if you think something can be improved