Mercurial > libervia-backend

annotate INSTALL @ 24:61124cb82fb7

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