From 58b0d58a60b39d43a946be02b338d333777d26a9 Mon Sep 17 00:00:00 2001
From: KoNicks <61112636+KoNickss@users.noreply.github.com>
Date: Sat, 3 Dec 2022 15:59:38 +0200
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..77afbf1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# nesem
+Nes Emulator in Progress (collab with RenDev)
+
+Currently only the CPU, BUS and CARTRIDGE (mapper 000 only) are done, left are the PPU and actual screen + controllers
+
+Currently all rights are reserved but when the project reaches beta I will release it under a very permissive license
+(0BSD, 0MIT, unlicense, something like that, might go with std BSD or MIT)
+
+## How to help:
+### (CPU)
+Download nestest.nes from [here](https://www.nesdev.org/wiki/Emulator_tests)
+
+Compile with debug (`make debug`)
+
+Run with nestest.nes into a logfile (`./nesem nestest.nes > logfile`)
+
+Compare logfile with provided sampleoutput file that contains expected NES 6502 behaviour, fix any errors that cause branching
+
+
+### (PPU)
+Start work on PPU
+
+### (Cartridge)
+Add mappers