From: @slackito <slack@codemaniacs.com>
Date: Fri, 24 May 2013 11:58:29 +0000 (+0200)
Subject: Create README.md
X-Git-Url: http://slack.codemaniacs.com/git/?a=commitdiff_plain;h=9dea4ea9e5909afe9b3d5254ca4a3599173c35af;p=wenboi.git

Create README.md

Simple README with build instructions
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7f23511
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+wenboi
+======
+
+A simple Game Boy emulator
+
+Build instructions
+==================
+
+wenboi uses CMake for building and depends on Qt, so you should install
+the qt development package for your distro of choice and do this at the
+repository root:
+
+    mkdir build
+    cd build
+    cmake ..
+    make
+    
+This will build libwenboicore.a, the wenboi core library, qtboi, the
+emulator front-end, and wendi, the old wenboi disassembler. The emulator
+front-end has an integrated debugger and interactive disassembler, you
+probably want to run that one :)