1 files changed, 39 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..cc8e664
--- /dev/null
+++ b/README
@@ -0,0 +1,39 @@
+DODAI
+
+A Python module to help with writing command line scripts
+
+This module is to be a foundation to your command line python
+scripts. This module provides for quick access to logger, configparser,
+optionparse and databases via sqlalchemy.
+
+
+INSTALLATION
+------------
+
+There are three ways to install dodai
+
+1. The easy_install method
+
+        easy_install dodai
+
+2.  To do a traditional install, download compressed file from:
+    http://code.google.com/p/dodai/downloads/list
+
+        tar zxvf dodai-*
+        cd dodai-*
+        python setup.py install
+
+3.  If you have Paver installed then download compressed file from
+    http://code.google.com/p/dodai/downloads/list
+
+        tar zxvf dodai-*
+        cd dodai-*
+        paver install
+
+
+The installation will also install sqlalchemy.  This installation will not
+install the required system and python libs needed to get sqlalchemy to work
+with your desired database.  This includes things like: cx_Oracle, psycopg2,
+pyodbc, mysql-python etc.  For more information on installing these check out
+the docs at http://code.google.com/p/dodai
+