diff README.txt @ 4:1fa9ca23d696

include description from README
author k0s <k0scist@gmail.com>
date Tue, 02 Mar 2010 16:34:51 -0500
parents
children fe197282c615
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.txt	Tue Mar 02 16:34:51 2010 -0500
@@ -0,0 +1,28 @@
+buttercup: a flower for k0s.org
+===============================
+
+buttercup is a `flower <TODO>`_ that is used to bloom a website like
+`k0s.org <http://k0s.org>`_.  There are several `python <http://python.org>`_
+components to a buttercup website:
+
+ * `decoupage <http://k0s.org/portfolio/software.html#decoupage>`_: for static files and indices
+   - `montage <http://k0s.org/portfolio/software.html#montage>`_for image galleries
+   - contenttransformer for static file presentation
+ * `bitsyblog <http://k0s.org/portfolio/software.html#bitsblog`_ for blogging
+ * a set of mercurial repositories
+ * software demos:
+   - anagram
+   - wordstream
+
+why is buttercup so messy?
+--------------------------
+
+Easy.  Its the backport of a highly specific website to a flower.  The
+buttercup flower is in fact a study in botany, useful in the study of
+species, but probably less interesting as a practical deployment.
+
+
+does buttercup work yet?
+------------------------
+
+No.  It is still a work in progress.