diff INSTALL @ 885:c8a7019cd168

better INSTALL instructions
author Goffi <goffi@goffi.org>
date Fri, 28 Feb 2014 14:41:51 +0100
parents 5d08ab99e8dd
children 2be46f391cfa
line wrap: on
line diff
--- a/INSTALL	Fri Feb 28 14:39:45 2014 +0100
+++ b/INSTALL	Fri Feb 28 14:41:51 2014 +0100
@@ -1,3 +1,56 @@
+You can install SàT automatically using easy_install or pip, and it is available in several GNU/Linux distributions. The full instructions are available on the wiki: http://wiki.goffi.org/wiki/Salut_%C3%A0_Toi
+Below is are installation instructions, but check wiki which may be more up-to-date
+
 ***
-You can install SàT automatically using easy_install or pip, and it is available in several GNU/Linux distributions. The full instructions are available on the wiki: http://wiki.goffi.org/wiki/Salut_%C3%A0_Toi
-***
+
+You can automatically install SàT and his dependencies using easy_install or pip. You will however need to install Python's headers (needed to build some packages), WxPython which is available in most Gnu/Linux distributions, PyGObject and developments version of libxml2 and libxslt (to compile lxml python library).
+
+The environment variable SAT_INSTALL customise the installation, it contains flags separated by spaces:
+	- "nopreinstall" skip all preinstallation checks
+	- "autodeb" automatically install missing packages on Debian based distributions
+	- "nox" disable installation of X based packages (WxWidgets), this is useful for servers
+
+WxPython and PyGobject are automatically installed on Debian based distributions if "autodeb" option is set. Indeed, on Debian based distribution, you can type (with the root account):
+
+# apt-get install python-pip python-dev libxml2-dev libxslt-dev
+# SAT_INSTALL=autodeb pip install .
+
+On a *buntu, same commands with sudo:
+
+$ sudo apt-get install python-pip python-dev libxml2-dev libxslt-dev
+$ SAT_INSTALL=autodeb sudo pip install .
+
+
+After installing SàT, you need to install the media:
+
+$ mkdir -p ~/sat/media/destination/path
+$ cd ~/sat/media/destination/path
+wget ftp://ftp.goffi.org/sat_media/sat_media.tar.bz2
+tar -jxvf sat_media.tar.bz2
+
+then, create a ~/.sat.conf file which contains:
+
+### sat.conf ###
+[DEFAULT]
+media_dir=~/sat/media/destination/path
+### end sat.conf ###
+
+Of course, replace ~/sat/media/destination/path with the actual path you want to use.
+
+You should now be able to launch sat:
+	- to launch the backend, enter
+$ sat
+	- to stop the backend, enter:
+$ sat stop
+	- to launch Primitivus, enter:
+$ primitivus
+	then create a profile.
+	- to launch Wix, enter
+$ wix
+	then create a profile.
+	- to use jp, follow its help:
+$ jp --help
+
+For Libervia, the web interface, check http://wiki.goffi.org/wiki/Libervia/en
+
+If you need help, come the SàT official XMPP room: sat@chat.jabberfr.org