comparison INSTALL @ 24:61124cb82fb7

Updated README and licenses (for images), added installation instructions.
author Goffi <goffi@goffi.org>
date Tue, 01 Dec 2009 07:55:46 +0100
parents
children 22cbd3837233
comparison
equal deleted inserted replaced
23:925ab466c5ec 24:61124cb82fb7
1 The following instructions are for GNU/Linux operating system. Instruction for other OS will come in the future.
2
3 /!\ WARNING /!\
4 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).
5
6 ** DEPENDENCIES:
7
8 To use SàT, you will need to install:
9 - twisted (http://twistedmatrix.com/trac/) which is found in most distributions, at least core, web and words must be installed
10 - progressbar (http://pypi.python.org/pypi/progressbar/2.2) which can be installed with easy_install
11 - wokkel (http://wokkel.ik.nu/), please read instructions on website to download/install. You must apply the patch found at http://wokkel.ik.nu/ticket/56
12 - wxWidgets (www.wxwidgets.org) which is found in most distributions. The more recent the version is, the better.
13
14 ** PATHS:
15
16 You must have the main dir (with sat inside) and frontend in your PYTHONPATH. For exemple, if you have uncompressed the soft in /tmp/useless_soft:
17
18 > export PYTHONPATH=$PYTHONPATH:/tmp/useless_soft:/tmp/useless_soft/frontends
19
20 if you want to access jp, it can be a good idea to export its dir to your PATH variable:
21
22 > export PATH=$PATH:/tmp/useless_soft/frontends/jp
23
24
25 ** INSTRUCTIONS:
26
27 Here are the instructions for the distribution I use (Kubuntu Karmic Koala), but instructions for other Gnu/Linux distributions must be really close.
28 To install SàT on a *buntu distribution, you first need to install dependencies:
29
30 > sudo aptitude install python-twisted python-twisted-core python-twisted-web python-twisted-word python-wxgtk2.8
31
32 You maybe need an updated repository for wxPython, take a look at http://wiki.wxpython.org/InstallingOnUbuntuOrDebian for more informations.
33
34 progressbar can be installed with easy_install:
35 > sudo easy_install progressbar
36
37 Wokkel is a bit more complicated to install as we need to patch it:
38
39 First be sure that mercurial is installed
40 > sudo aptitude install mercurial
41
42 then we go to a directory where we can clone the repository and patch the sources. If you don't want to code on wokkel, you can do it in /tmp:
43
44 > cd /tmp
45 > hg clone http://hg.ik.nu/wokkel
46
47 now we need to download and use the patch:
48
49 > cd wokkel/wokkel
50 > wget http://wokkel.ik.nu/raw-attachment/ticket/56/patch
51 > patch -p0 < patch
52
53 now it's time to install:
54
55 > cd ..
56 > sudo python setup.py install
57
58 Everything is fine ? Ok let's add the paths.
59
60 If you use bash, you need probably to do something like
61 > echo "export PYTHONPATH=$PYTHONPATH:~/sat:~/sat/frontends" >> ~/.bashrc
62 > echo "export PATH=$PATH:~/sat/frontends/jp" >> ~/.bashrc
63
64 of course, replace ~/sat with the path where you installed SàT, and if you use zsh, replace .bashrc by .zshrc.
65 Restart a console or export manually the PATH.
66
67 Now everything should be OK, you can launch SàT. You have to launch the daemon first:
68 > cd ~/sat
69 > ./sat
70
71 You should be able to close you console or even X Window if you want.
72
73 Then launch one (ore more) frontend. For exemple, to use Wix:
74 > cd ~/sat/frontends/wix
75 > ./wix
76
77 enjoy =)
78 And don't hesitate to give feedback.
79