summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst56
1 files changed, 56 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..576a3ed
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,56 @@
+The auspicious and venerable Leafy Miracle
+==========================================
+
+::
+
+|-----------------------------------------------|
+| _______________ |
+| < leafymiracle! > |
+| --------------- |
+| \ |
+| \ .---. __ |
+| , \ / \ \ |||| |
+| \\\\ |O___O | | \\|||| |
+| \ // | \_/ | | \ / |
+| '--/----/| / | |-' |
+| // // / -----' |
+| // \\ / / |
+| // // / / |
+| // \\ / / |
+| // // / / |
+| /| ' / / |
+| //\___/ / |
+| // ||\ / |
+| \\_ || '---' |
+| /' / \\_.- |
+| / / --| | |
+| '-' | | |
+| '-' |
+|_______________________________________________|
+
+Features
+~~~~~~~~
+
+* Written in Python using the Pyramid web framework
+* SQLAlchemy database model of Categories
+* Interactive graph widget, using ToscaWidgets2 and the JIT
+* Package mouse-over menus linking to downloads, acls, code
+ bugs, builds and updates.
+* Deep linking
+
+Running
+~~~~~~~
+
+::
+
+$ mkvirtualenv --no-site-packages leafymiracle
+$ workon leafymiracle
+$ python setup.py develop
+$ python leafymiracle/populate.py
+$ paster serve development.ini
+
+Authors
+~~~~~~~
+
+* Luke Macken <lmacken@redhat.com>
+* Ralph Bean <ralph.bean@gmail.com>