From 1f00d73064659f3121cf170cb9351cf26799d11e Mon Sep 17 00:00:00 2001
From: DeedleFake <yisszev@beckforce.com>
Date: Wed, 1 Aug 2012 23:04:17 -0400
Subject: [PATCH] Add README.md and TODO.

---
 README.md | 31 +++++++++++++++++++++++++++++++
 TODO      |  3 +++
 2 files changed, 34 insertions(+)
 create mode 100644 README.md
 create mode 100644 TODO

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e471219
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+Go Bindings for SDL 2
+=====================
+
+This [Go][golang] package provides bindings for [SDL][sdl] 2. It mostly follows the same API, but substitutes the 'SDL\_' prefix in the C definitions with the sdl package prefix. Thus, the C function
+
+> SDL\_CreateWindow()
+
+would be
+
+> sdl.CreateWindow()
+
+in this package. Also, some functions have been changed to methods of related types where it seemed appropriate. Thus, this package's equivalent for
+
+> SDL\_CreateRenderer()
+
+is
+
+> (\*Window)CreateRenderer()
+
+in this package.
+
+_Note: This is not yet finished. It is capable of loading and displaying images and handling events, but it many things do not have bindings, nor has it been thourouly tested. Expect bugs and missing features._
+
+Prerequisites
+-------------
+
+ * [SDL][sdl] 2 (Still in development as of 2012-08-01.)
+ * [Go][golang]
+
+[golang]: http://www.golang.org
+[sdl]: http://www.libsdl.org
diff --git a/TODO b/TODO
new file mode 100644
index 0000000..2848419
--- /dev/null
+++ b/TODO
@@ -0,0 +1,3 @@
+Implement better tests. For all I know, large parts of this are horribly broken.
+
+For more, see TODO comments in individual files.