LibAST: Library of Assorted Spiffy Things.

SVN revision: 3792

1 files changed, 28 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..d7cb370
--- /dev/null
+++ b/README
@@ -0,0 +1,28 @@
+LibAST README
+-------------
+
+LibAST is the Library of Assorted Spiffy Things.  It contains many
+spiffy things, and it is a library.  Thus, the ever-so-creative name.
+LibAST has been previously known as libmej, the Eterm helper library
+which nobody really understood and certainly never used.  My current
+plan is to gradually remove some of the neat stuff from Eterm that
+could be made generic (things like the theme parsing engine, the
+command-line options parser, perhaps the event engine, ...) and place
+it here in the hopes that others will find them useful.
+
+Building LibAST
+---------------
+
+From the top of the source tree, type each of the following and hit
+Enter after each:
+
+  ./configure
+  make
+	
+Installing LibAST
+-----------------
+
+After performing the build step above, run:
+
+  make install
+