annotate README @ 2:c49345fd7737

refactoring: moved sat to sat.tac, now a twisted application so we can use twistd.
author Goffi <goffi@goffi.org>
date Mon, 19 Oct 2009 22:45:52 +0200
parents c4bc297b82f0
children 61124cb82fb7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
goffi@necton2
parents:
diff changeset
1 SàT
goffi@necton2
parents:
diff changeset
2 (c) Jérôme Poisson aka Goffi 2008,2009
goffi@necton2
parents:
diff changeset
3
goffi@necton2
parents:
diff changeset
4 SàT is a XMPP (Jabber) client.
goffi@necton2
parents:
diff changeset
5
goffi@necton2
parents:
diff changeset
6
goffi@necton2
parents:
diff changeset
7
goffi@necton2
parents:
diff changeset
8
goffi@necton2
parents:
diff changeset
9
goffi@necton2
parents:
diff changeset
10 ** LICENSE **
goffi@necton2
parents:
diff changeset
11
goffi@necton2
parents:
diff changeset
12 SàT is free software: you can redistribute it and/or modify
goffi@necton2
parents:
diff changeset
13 it under the terms of the GNU General Public License as published by
goffi@necton2
parents:
diff changeset
14 the Free Software Foundation, either version 3 of the License, or
goffi@necton2
parents:
diff changeset
15 (at your option) any later version.
goffi@necton2
parents:
diff changeset
16
goffi@necton2
parents:
diff changeset
17 SàT is distributed in the hope that it will be useful,
goffi@necton2
parents:
diff changeset
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
goffi@necton2
parents:
diff changeset
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
goffi@necton2
parents:
diff changeset
20 GNU General Public License for more details.
goffi@necton2
parents:
diff changeset
21
goffi@necton2
parents:
diff changeset
22 You should have received a copy of the GNU General Public License
goffi@necton2
parents:
diff changeset
23 along with SàT. If not, see <http://www.gnu.org/licenses/>.
goffi@necton2
parents:
diff changeset
24
goffi@necton2
parents:
diff changeset
25
goffi@necton2
parents:
diff changeset
26
goffi@necton2
parents:
diff changeset
27 It is currently in a very alpha stage, and absolutely not usable for everyday use, use at your own risks !
goffi@necton2
parents:
diff changeset
28
goffi@necton2
parents:
diff changeset
29
goffi@necton2
parents:
diff changeset
30
goffi@necton2
parents:
diff changeset
31
goffi@necton2
parents:
diff changeset
32
goffi@necton2
parents:
diff changeset
33 ** WTF ? **
goffi@necton2
parents:
diff changeset
34 SàT is a XMPP (Jabber) client, made on a daemon/frontend architecture. Its aim is not only to be an instant messagery client: XMPP offer a lot more, and differents tools will come in the future.
goffi@necton2
parents:
diff changeset
35
goffi@necton2
parents:
diff changeset
36 For the moment, the frontends are:
goffi@necton2
parents:
diff changeset
37
goffi@necton2
parents:
diff changeset
38 * wix: a wxwidget frontend, the main graphical frontend
goffi@necton2
parents:
diff changeset
39 * sortilège: a ncurses client, for screen lovers
goffi@necton2
parents:
diff changeset
40 * jp: the command line toolkit. The tool for geeks by geeks
goffi@necton2
parents:
diff changeset
41
goffi@necton2
parents:
diff changeset
42 other frontends planed in the near future:
goffi@necton2
parents:
diff changeset
43
goffi@necton2
parents:
diff changeset
44 * a web frontend
goffi@necton2
parents:
diff changeset
45 * a KDE 4 frontend, as KDE is my main desktop environment
goffi@necton2
parents:
diff changeset
46
goffi@necton2
parents:
diff changeset
47
goffi@necton2
parents:
diff changeset
48
goffi@necton2
parents:
diff changeset
49
goffi@necton2
parents:
diff changeset
50
goffi@necton2
parents:
diff changeset
51 ** How to use it ? **
goffi@necton2
parents:
diff changeset
52
goffi@necton2
parents:
diff changeset
53 SàT is really at an early dev stage, so it's maybe the buggiest software you have ever seen, and there are for the moment absolutely nothing to ease the installation and use (but it will be the case ASAP, one of the goal of the project is the ease of use).
goffi@necton2
parents:
diff changeset
54 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:
goffi@necton2
parents:
diff changeset
55
goffi@necton2
parents:
diff changeset
56 $ export PYTHONPATH=$PYTHONPATH:/tmp/useless_soft:/tmp/useless_soft/frontends
goffi@necton2
parents:
diff changeset
57
goffi@necton2
parents:
diff changeset
58 if you wants to access jp, it can be a good idea to export its dir to your PATH:
goffi@necton2
parents:
diff changeset
59
goffi@necton2
parents:
diff changeset
60 $ export PATH=$PATH:/tmp/useless_soft/frontends/jp
goffi@necton2
parents:
diff changeset
61
goffi@necton2
parents:
diff changeset
62 There will probably be a wiki doc in the future.
goffi@necton2
parents:
diff changeset
63
goffi@necton2
parents:
diff changeset
64
goffi@necton2
parents:
diff changeset
65
goffi@necton2
parents:
diff changeset
66
goffi@necton2
parents:
diff changeset
67
goffi@necton2
parents:
diff changeset
68 ** Misc **
goffi@necton2
parents:
diff changeset
69
goffi@necton2
parents:
diff changeset
70 -- Shortcuts for sortilège (temporary):
goffi@necton2
parents:
diff changeset
71 C-L: access contact list (enter to valid)
goffi@necton2
parents:
diff changeset
72 F2: Show/Hide contact list
goffi@necton2
parents:
diff changeset
73 C-S: Short representation of contacts in chat window
goffi@necton2
parents:
diff changeset
74 C-C: Use colors... or not
goffi@necton2
parents:
diff changeset
75 C-T: Timestamp
goffi@necton2
parents:
diff changeset
76 C-X: Leave
goffi@necton2
parents:
diff changeset
77 --
goffi@necton2
parents:
diff changeset
78
goffi@necton2
parents:
diff changeset
79 SàT is the acronym (yes another one :( ) in tribute to the song Salut à Toi from the Bérurier Noir band. I recommand also the excelent cover from Les Ogres de Barback.
goffi@necton2
parents:
diff changeset
80 jp stands for Jabber coPy or JumP. If you look well, you can also find my initials ;)
goffi@necton2
parents:
diff changeset
81 sortilège means "spell" in french, and it is ncurses based...
goffi@necton2
parents:
diff changeset
82 wix come of course from the WX of wxwidgets and just sound cool :).
goffi@necton2
parents:
diff changeset
83
goffi@necton2
parents:
diff changeset
84
goffi@necton2
parents:
diff changeset
85
goffi@necton2
parents:
diff changeset
86
goffi@necton2
parents:
diff changeset
87
goffi@necton2
parents:
diff changeset
88 ** Credit **
goffi@necton2
parents:
diff changeset
89
goffi@necton2
parents:
diff changeset
90 proxy65:
goffi@necton2
parents:
diff changeset
91 SàT (plugin_xep_0065) use nearly all the code from proxy65 (http://code.google.com/p/proxy65/) wich was coded by Dave Smith (2002-2004) and maintained by Fabio Forno (2007-2008).
goffi@necton2
parents:
diff changeset
92 As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code. Thanks a lot to them !
goffi@necton2
parents:
diff changeset
93
goffi@necton2
parents:
diff changeset
94 progressbar:
goffi@necton2
parents:
diff changeset
95 SàT (jp) use ProgressBar (http://pypi.python.org/pypi/progressbar/2.2), a class coded by Nilton Volpato which allow the textual representation of progression. thanks to him
goffi@necton2
parents:
diff changeset
96
goffi@necton2
parents:
diff changeset
97 twisted:
goffi@necton2
parents:
diff changeset
98 SàT is based on the twisted framework (http://twistedmatrix.com/trac/), a very great tools which offer a lot of protocols management. There are too many contributors to name them here, so take a look on the website :). Again, thanks to them
goffi@necton2
parents:
diff changeset
99
goffi@necton2
parents:
diff changeset
100 and the others:
goffi@necton2
parents:
diff changeset
101 and of course, nothing would be possible without Python (http://www.python.org/), Gnu and the Free Software Foundation (http://www.gnu.org, http://www.fsf.org/), the Linux Kernel (http://www.kernel.org/), and the coder of the tools I use like Vim (http://www.vim.org/), Mercurial (http://www.selenic.com/mercurial/wiki/), or all the KDE stuff (http://www.kde.org/ and of course http://amarok.kde.org/), etc. Thanks thanks thanks, thank to everybody in the Free (Libre) chain for making a part of the dream.
goffi@necton2
parents:
diff changeset
102
goffi@necton2
parents:
diff changeset
103
goffi@necton2
parents:
diff changeset
104
goffi@necton2
parents:
diff changeset
105
goffi@necton2
parents:
diff changeset
106
goffi@necton2
parents:
diff changeset
107 ** Contact **
goffi@necton2
parents:
diff changeset
108
goffi@necton2
parents:
diff changeset
109 You can contact me on goffi@goffi.org . Yes I know, I don't give my JID ;)
goffi@necton2
parents:
diff changeset
110 You'll find the latest version on my website: http://www.goffi.org (it's mainly in french, I will probably make a little part in english in the future).
goffi@necton2
parents:
diff changeset
111
goffi@necton2
parents:
diff changeset
112
goffi@necton2
parents:
diff changeset
113
goffi@necton2
parents:
diff changeset
114 This software is dedicated to Roger Poisson.