aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorPriit Laes <plaes@plaes.org>2010-06-25 16:26:06 +0300
committerPriit Laes <plaes@plaes.org>2010-06-25 16:26:06 +0300
commit0c8e1e9e624478adf9ad80b7bb6aa9a1e2665173 (patch)
tree156b670918d54984c3f3128993a3f13c6dbe3690 /README
parentSQLAlchemy/PostgreSQL instead of MongoDB (diff)
downloadgsoc2010-grumpy-0c8e1e9e624478adf9ad80b7bb6aa9a1e2665173.tar.gz
gsoc2010-grumpy-0c8e1e9e624478adf9ad80b7bb6aa9a1e2665173.tar.bz2
gsoc2010-grumpy-0c8e1e9e624478adf9ad80b7bb6aa9a1e2665173.zip
Added README
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 28 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..acc516b
--- /dev/null
+++ b/README
@@ -0,0 +1,28 @@
+Project Grumpy
+==============
+
+Project Grumpy is a maintainer-oriented set of tools for handling various
+developer-related metadata.
+
+Requirements
+------------
+
+ - Python-2.5+
+ - pkgcore
+ - SQLAlchemy-0.6
+
+Database support
+----------------
+
+Although main development is aimed towards use of PostgreSQL, most of the
+databases supported by SQLAlchemy should work fine.
+
+Database configuration is defined by specifying the RFC-1738 style uri::
+
+ dialect+driver://username:password@host:port/database
+
+
+Installation
+------------
+
+TBD.