comparison INSTALL @ 871:5d08ab99e8dd

README and INSTALL updates
author Goffi <goffi@goffi.org>
date Wed, 26 Feb 2014 00:36:34 +0100
parents 952322b1d490
children c8a7019cd168
comparison
equal deleted inserted replaced
870:e030460e065e 871:5d08ab99e8dd
1 *** 1 ***
2 Below are the old manual instructions for installation, you can install SàT automatically using easy_install or pip. The full instructions are available on the wiki: http://wiki.goffi.org/wiki/Salut_%C3%A0_Toi 2 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
3 *** 3 ***
4
5
6 The following instructions are for GNU/Linux operating system. Instruction for other OS will come in the future.
7
8 /!\ WARNING /!\
9 SàT is at a very early developpement stage, and is not intended for end user yet. You need to understand a minimum what you do to install it. Anyway, you can contact me if you need help (but I'm really busy, so don't expect a quick and accurate answer).
10
11 ** DEPENDENCIES:
12
13 To use SàT, you will need to install:
14 - twisted (http://twistedmatrix.com/trac/) which is found in most distributions, at least core, web and words must be installed
15 - progressbar (http://pypi.python.org/pypi/progressbar/2.2) which can be installed with easy_install
16 - wokkel (http://wokkel.ik.nu/). /!\ the MUC branch (http://hg.ik.nu/ralphm/wokkel-muc-client-support-24-2) must be merged, please read instructions below
17 - wxWidgets (http://www.wxwidgets.org) which is found in most distributions. The more recent the version is, the better.
18 - urwid (http://excess.org/urwid/) which can be installed with easy_install
19 - Mutagen (http://code.google.com/p/mutagen/) which can be installed with easy_install
20
21 ** PATHS:
22
23 You must have the main dir (with sat inside) and frontend in your PYTHONPATH. For example, if you have uncompressed the soft in /tmp/useless_soft:
24
25 > export PYTHONPATH=$PYTHONPATH:/tmp/useless_soft:/tmp/useless_soft/frontends
26
27 if you want to access jp, it can be a good idea to export its dir to your PATH variable:
28
29 > export PATH=$PATH:/tmp/useless_soft/frontends/jp
30
31
32 ** INSTRUCTIONS:
33
34 Here are the instructions for the distribution I use (Kubuntu Karmic Koala), but instructions for other Gnu/Linux distributions must be really close.
35 To install SàT on a *buntu distribution, you first need to install dependencies:
36
37 > sudo aptitude install python-twisted python-twisted-core python-twisted-web python-twisted-words python-wxgtk2.8
38
39 You maybe need an updated repository for wxPython, take a look at http://wiki.wxpython.org/InstallingOnUbuntuOrDebian for more informations.
40
41 ProgressBar and Urwid can be installed with easy_install, or throught apt:
42 > sudo aptitude install python-progressbar python-urwid
43
44 Wokkel is a bit more complicated to install as we need to merge two branches:
45
46 First be sure that mercurial is installed
47 > sudo aptitude install mercurial
48
49 then we go to a directory where we can clone the repositories and merge. If you don't want to code on wokkel, you can do it in /tmp:
50
51 > cd /tmp
52 > hg clone http://hg.ik.nu/wokkel wokkel
53
54 now we pull the other branch:
55 > cd wokkel
56 > hg pull -f http://hg.ik.nu/ralphm/wokkel-muc-client-support-24-2
57
58 time to merge and commit:
59 > hg merge wokkel-muc-client-support-24
60 > hg commit -m "Merged wokkel's MUC branch"
61
62 finally,we can install:
63
64 > sudo python setup.py install
65
66 Everything is fine ? Ok let's add the paths.
67
68 If you use bash, you need probably to do something like
69 > echo "export PYTHONPATH=$PYTHONPATH:~/sat:~/sat/frontends" >> ~/.bashrc
70 > echo "export PATH=$PATH:~/sat/frontends/jp" >> ~/.bashrc
71
72 of course, replace ~/sat with the path where you installed SàT, and if you use zsh, replace .bashrc by .zshrc.
73 Restart a console or export manually the PATH.
74
75 Now everything should be OK, you can launch SàT. You have to launch the daemon first:
76 > cd ~/sat
77 > ./sat
78
79 You should be able to close you console or even X Window if you want.
80
81 Then launch one (ore more) frontend. For exemple, to use Wix:
82 > cd ~/sat/frontends/wix
83 > ./wix
84
85 enjoy =)
86 And don't hesitate to give feedback.
87