From c088a5a0721405b5f24dd65f4c3406af530c44f5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sergiusz=20=27q3k=27=20Baza=C5=84ski?= <q3k@q3k.org>
Date: Tue, 16 Dec 2014 23:14:59 +0100
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fb58f2d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+q3kmips
+=======
+
+The little MIPS that couldn't.
+
+What is it?
+-----------
+
+It's a classic-pipeline, hand-crafted, partial MIPS32 implementation. It probably doesn't hold any intristic value, as it's a way for me to learn computer architecture from the ground up.
+
+See `pipeline.grphml` for a yEd diagram of what this whole thing looks like.
+
+Is it any good?
+---------------
+
+Not yet, really. It's a work in progress - the Fetch and ICache modules seem to be working and are tested. The decode stage is in progress, the rest is planned.