From: Nick Bowler <nbowler@draconx.ca>
Date: Sun, 15 Mar 2009 21:14:24 +0000 (-0400)
Subject: Add a short readme.
X-Git-Url: https://git.draconx.ca/gitweb/aspectbin.git/commitdiff_plain/52fc004ac5fc97e387412b61604bec0ab845a970

Add a short readme.
---

diff --git a/README b/README
new file mode 100644
index 0000000..0b09c83
--- /dev/null
+++ b/README
@@ -0,0 +1,15 @@
+AspectBin - A GTK+ container for packing with constrained aspect ratio.
+
+SYNOPSIS
+
+AspectBin is a container which packs two widgets next to each other: one with
+a constrained aspect ratio and another which fits in the remaining space.  It
+is conceptually similar to the AspectFrame, but attempts to not waste space on
+padding.  AspectBin is primarily intended for games that have an aspect
+constrained playing area with status information on the side.  Some of the
+problems that AspectBin attempts to solve are:
+
+  * A square playing area centred vertically in the window, with status
+    information to the right, aligned with the top of the playing area.
+  * Status information centred horizontally in the space remaining to the right
+    of a playing area.