changeset 4:1fa9ca23d696

include description from README
author k0s <k0scist@gmail.com>
date Tue, 02 Mar 2010 16:34:51 -0500
parents d5c80480b967
children 9a37a94fed68
files README.txt setup.py
diffstat 2 files changed, 34 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/README.txt
@@ -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.
--- a/setup.py
+++ b/setup.py
@@ -1,15 +1,21 @@
 from setuptools import find_packages, setup
 
+try:
+    description = file("README.txt").read()
+except:
+    description = ''
+
 version='0.0'
 
 setup(name='buttercup',
       version=version,
       description="paste template for creating instances of the buttercup flower website pattern",
+      long_description=description,
       author='Jeff Hammel',
       author_email='k0scist@gmail.com',
       url='http://k0s.org',
       keywords='trac plugin',
       license="",
       packages=find_packages(exclude=['ez_setup', 'examples', 'tests*']),
       include_package_data=True,
       install_requires = [ 'PasteScript' ],