Merge 'upstream/saas-4' into saas-4
[odoo/odoo.git] / README
diff --git a/README b/README
index e255e36..9449819 100644 (file)
--- a/README
+++ b/README
@@ -1,29 +1,61 @@
-pydot - Python interface to Graphviz's Dot language
-Ero Carrera (c) 2004-2007
-ero@dkbza.org
+About OpenERP
+-------------
 
-This code is distributed under the MIT license.
+OpenERP is an OpenSource/Free software Enterprise Resource Planning and
+Customer Relationship Management software. More info at:
 
-Requirements:
--------------
+    http://www.openerp.com
 
-pyparsing: pydot requires the pyparsing module in order to be
-       able to load DOT files.
+Installation on Debian/Ubuntu
+-----------------------------
 
-GraphViz:  is needed in order to render the graphs into any of
-       the plethora of output formats supported.
+Add the the apt repository
 
-Installation:
--------------
+    deb http://nightly.openerp.com/6.1/deb/ ./
+
+in your source.list and type:
+
+    $ sudo apt-get update
+    $ sudo apt-get install openerp
+
+Or download the deb file and type:
+
+    $ sudo dpkg -i <openerp-deb-filename>
+    $ sudo apt-get install install -f
+
+Installation on RedHat, Fedora, CentOS
+--------------------------------------
+
+Install the required dependencies:
+
+    $ yum install python
+    $ easy_install pip
+    $ pip install .....
+
+Install the openerp rpm
+
+    $ rpm -i openerp-VERSION.rpm
+
+Installation on Windows
+-----------------------
+
+    Check the notes in setup.py
+
+Installation on MacOSX
+-----------------------
+
+Setuping you first database
+---------------------------
 
-Should suffice with doing:
+Point your browser to http://localhost:8069/ and click "Manage Databases", the
+default master password is "admin".
 
- python setup.py install
+Detailed System Requirements
+----------------------------
 
-Needless to say, no installation is needed just to use the module. A mere:
+The dependencies are listed in setup.py
 
- import pydot
+For Luxembourg localization, you also need:
 
-should do it, provided that the directory containing the modules is on Python
-module search path.
+ pdftk (http://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/)