diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000000..ac14ddb5b8 --- /dev/null +++ b/INSTALL @@ -0,0 +1,38 @@ +Installing trytond +================== + +Prerequisites +------------- + + * Python 2.4 or later (http://www.python.org/) + * psycopg 2 or later (http://www.initd.org/) + * lxml (http://codespeak.net/lxml/) + * egenix-mx-base (http://www.egenix.com/products/python/) + * relatorio 0.2.0 or later (http://relatorio.openhex.org/) + * Optional: pywebdav (http://sourceforge.net/projects/pywebdav/) + * Optional: pydot (http://code.google.com/p/pydot/) + * Optional: pytz (http://pytz.sourceforge.net/) + * Optional: openoffice.interact + (http://pypi.python.org/pypi/openoffice.interact/) + * Optional: sphinx (http://sphinx.pocoo.org/) + +Installation +------------ + +Once you've downloaded and unpacked a trytond source release, enter the +directory where the archive was unpacked, and run: + + python setup.py install + +Note that you may need administrator/root privileges for this step, as +this command will by default attempt to install trytond to the Python +site-packages directory on your system. + +For advanced options, please refer to the easy_install and/or the distutils +documentation: + + http://peak.telecommunity.com/DevCenter/EasyInstall + http://docs.python.org/inst/inst.html + +To use without installation, run ``bin/trytond`` from where the archive was +unpacked. diff --git a/MANIFEST.in b/MANIFEST.in index 0bef154d2c..6a996d97aa 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,5 +1,7 @@ include LICENSE include COPYRIGHT +include README +include INSTALL include doc/* include etc/* include trytond/init.sql diff --git a/README b/README new file mode 100644 index 0000000000..9e8bef4d2c --- /dev/null +++ b/README @@ -0,0 +1,57 @@ +trytond +======= + +The server of the Tryton application platform. +A three-tiers high-level general purpose application platform +written in Python and use Postgresql as database engine. +It is the core base of an Open Source ERP. +It provides modularity, scalability and security. + +Installing +---------- + +See INSTALL + +Package Contents +---------------- + + bin/ + Script for startup. + + doc/ + sphinx documentation in reStructuredText. + To generate the HTML: + + python doc/build.py + + etc/ + Configuration files. + + trytond/ + trytond. + +Support +------- + +If you encounter any problems with Tryton, please don't hesitate to ask +questions on the Tryton bug tracker, mailing list, wiki or IRC channel: + + http://bugs.tryton.org/ + http://groups.tryton.org/ + http://wiki.tryton.org/ + irc://irc.freenode.net/tryton + +License +------- + +See LICENSE + +Copyright +--------- + +See COPYRIGHT + + +For more information please visit the Tryton web site: + + http://www.tryton.org/