summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLuke Macken <lmacken@redhat.com>2008-07-07 13:14:42 -0400
committerLuke Macken <lmacken@redhat.com>2008-07-07 13:14:42 -0400
commit53da7df59ea74771dc8b92db74e44fdb4545881e (patch)
treeabffebb16795f23924d92474e68a7536619452c8
parent4551374a8805882a55a46616a4d147aad0bf9701 (diff)
downloadmanas-53da7df59ea74771dc8b92db74e44fdb4545881e.tar.gz
manas-53da7df59ea74771dc8b92db74e44fdb4545881e.tar.xz
manas-53da7df59ea74771dc8b92db74e44fdb4545881e.zip
Update the README
-rw-r--r--README.txt33
1 files changed, 24 insertions, 9 deletions
diff --git a/README.txt b/README.txt
index 2796e80..44d7513 100644
--- a/README.txt
+++ b/README.txt
@@ -1,19 +1,34 @@
-This file is for you to describe the manas application. Typically
-you would include information such as the information below:
+=====
+manas
+=====
+
+A community-driven knowledge sharing system.
+
+Features
+========
+
+- Allows anyone to submit and vote on ideas
+- Allows anyone submit, vote, and answer questions
+- Ideas update in real time using ``comet``
+- Uses jQuery for ajaxy hotness
+- Powered by TurboGears2/Pylons
+
Installation and Setup
======================
-Install ``manas`` using easy_install::
+Generate egg-info::
- easy_install manas
+ python setup.py egg_info
-Make a config file as follows::
+Tweak the config file as appropriate and then setup the application::
- paster make-config manas config.ini
+ paster setup-app development.ini
-Tweak the config file as appropriate and then setup the application::
+Start the orbited server
+
+ orbited orbited.cfg
- paster setup-app config.ini
+Start our application
-Then you are ready to go.
+ paster serve development.ini