annotate INSTALL @ 1039:902c764a0d2b

memory (params): fix parameters of type "list" to use the default option when no individual value is set
author souliane <souliane@mailoo.org>
date Tue, 20 May 2014 09:34:02 +0200
parents c8a7019cd168
children 2be46f391cfa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
885
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
1 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
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
2 Below is are installation instructions, but check wiki which may be more up-to-date
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
3
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 548
diff changeset
4 ***
885
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
5
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
6 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).
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
7
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
8 The environment variable SAT_INSTALL customise the installation, it contains flags separated by spaces:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
9 - "nopreinstall" skip all preinstallation checks
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
10 - "autodeb" automatically install missing packages on Debian based distributions
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
11 - "nox" disable installation of X based packages (WxWidgets), this is useful for servers
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
12
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
13 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):
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
14
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
15 # apt-get install python-pip python-dev libxml2-dev libxslt-dev
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
16 # SAT_INSTALL=autodeb pip install .
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
17
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
18 On a *buntu, same commands with sudo:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
19
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
20 $ sudo apt-get install python-pip python-dev libxml2-dev libxslt-dev
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
21 $ SAT_INSTALL=autodeb sudo pip install .
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
22
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
23
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
24 After installing SàT, you need to install the media:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
25
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
26 $ mkdir -p ~/sat/media/destination/path
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
27 $ cd ~/sat/media/destination/path
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
28 wget ftp://ftp.goffi.org/sat_media/sat_media.tar.bz2
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
29 tar -jxvf sat_media.tar.bz2
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
30
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
31 then, create a ~/.sat.conf file which contains:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
32
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
33 ### sat.conf ###
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
34 [DEFAULT]
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
35 media_dir=~/sat/media/destination/path
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
36 ### end sat.conf ###
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
37
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
38 Of course, replace ~/sat/media/destination/path with the actual path you want to use.
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
39
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
40 You should now be able to launch sat:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
41 - to launch the backend, enter
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
42 $ sat
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
43 - to stop the backend, enter:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
44 $ sat stop
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
45 - to launch Primitivus, enter:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
46 $ primitivus
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
47 then create a profile.
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
48 - to launch Wix, enter
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
49 $ wix
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
50 then create a profile.
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
51 - to use jp, follow its help:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
52 $ jp --help
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
53
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
54 For Libervia, the web interface, check http://wiki.goffi.org/wiki/Libervia/en
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
55
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
56 If you need help, come the SàT official XMPP room: sat@chat.jabberfr.org