annotate README @ 31:7b34ffa2ff45

Updated README and added CHANGELOG - README: added privacy warning for http://www.goffi.org/sat_tools/get_ip.php access - CHANGELOG: first changelog (first public release for v0.0.1)
author Goffi <goffi@goffi.org>
date Tue, 08 Dec 2009 08:05:38 +0100
parents f1db7ffbe6a7
children a5b5fb5fc9fd
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
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
53 For installation instructions, please read the file "INSTALL".
0
goffi@necton2
parents:
diff changeset
54
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
55 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).
0
goffi@necton2
parents:
diff changeset
56 There will probably be a wiki doc in the future.
goffi@necton2
parents:
diff changeset
57
goffi@necton2
parents:
diff changeset
58
goffi@necton2
parents:
diff changeset
59
goffi@necton2
parents:
diff changeset
60
goffi@necton2
parents:
diff changeset
61
goffi@necton2
parents:
diff changeset
62 ** Misc **
goffi@necton2
parents:
diff changeset
63
goffi@necton2
parents:
diff changeset
64 -- Shortcuts for sortilège (temporary):
goffi@necton2
parents:
diff changeset
65 C-L: access contact list (enter to valid)
goffi@necton2
parents:
diff changeset
66 F2: Show/Hide contact list
goffi@necton2
parents:
diff changeset
67 C-S: Short representation of contacts in chat window
goffi@necton2
parents:
diff changeset
68 C-C: Use colors... or not
goffi@necton2
parents:
diff changeset
69 C-T: Timestamp
goffi@necton2
parents:
diff changeset
70 C-X: Leave
goffi@necton2
parents:
diff changeset
71 --
goffi@necton2
parents:
diff changeset
72
goffi@necton2
parents:
diff changeset
73 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
74 jp stands for Jabber coPy or JumP. If you look well, you can also find my initials ;)
goffi@necton2
parents:
diff changeset
75 sortilège means "spell" in french, and it is ncurses based...
goffi@necton2
parents:
diff changeset
76 wix come of course from the WX of wxwidgets and just sound cool :).
goffi@necton2
parents:
diff changeset
77
goffi@necton2
parents:
diff changeset
78
31
7b34ffa2ff45 Updated README and added CHANGELOG
Goffi <goffi@goffi.org>
parents: 27
diff changeset
79 ** /!\ Privacy warning /!\ **
0
goffi@necton2
parents:
diff changeset
80
31
7b34ffa2ff45 Updated README and added CHANGELOG
Goffi <goffi@goffi.org>
parents: 27
diff changeset
81 To make setup easier, SàT ask my website (http://www.goffi.org) the external ip address of client. So a request is made to this page: http://www.goffi.org/sat_tools/get_ip.php .
7b34ffa2ff45 Updated README and added CHANGELOG
Goffi <goffi@goffi.org>
parents: 27
diff changeset
82 The IP are not collected. Future releases will probably come with a warning about this and an easy way to avoid it.
0
goffi@necton2
parents:
diff changeset
83
goffi@necton2
parents:
diff changeset
84
goffi@necton2
parents:
diff changeset
85 ** Credit **
goffi@necton2
parents:
diff changeset
86
goffi@necton2
parents:
diff changeset
87 proxy65:
goffi@necton2
parents:
diff changeset
88 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
89 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
90
goffi@necton2
parents:
diff changeset
91 progressbar:
goffi@necton2
parents:
diff changeset
92 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
93
goffi@necton2
parents:
diff changeset
94 twisted:
goffi@necton2
parents:
diff changeset
95 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
96
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
97 wokkel:
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
98 SàT use a library with high level enhancements on top of twisted, which is called wokkel (http://wokkel.ik.nu). Lot of thanks to Ralph Meijer and all other contributors.
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
99
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
100 wxWidgets & wxPython:
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
101 The Wix frontend is made with wxWidgets (www.wxwidgets.org) and its python version wxPython (wxPython), which is a really handy UI toolkit who works on most popular platforms. It can be found on probably all major Gnu/Linux distributions. as usual, thanks to the authors.
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
102
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
103 pictures found in frontends/wix/images:
27
f1db7ffbe6a7 LICENSE renamed to COPYING in readme files, according to gnu's website suggestion
Goffi <goffi@goffi.org>
parents: 24
diff changeset
104 These pictures come from Crystal clear, were made by Everaldo Coelho (www.everaldo.com) and YellowIcon (www.yellowicon.com). They are under LGPL V3 licence (see frontends/wix/images/COPYING.LESSER). Thanks to them.
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
105 Found on http://commons.wikimedia.org/wiki/File:Crystal_Clear_app_browser.png and http://commons.wikimedia.org/wiki/File:Crystal_Clear_app_cache.png
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
106
0
goffi@necton2
parents:
diff changeset
107 and the others:
goffi@necton2
parents:
diff changeset
108 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
109
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
110 If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
111
0
goffi@necton2
parents:
diff changeset
112
goffi@necton2
parents:
diff changeset
113
goffi@necton2
parents:
diff changeset
114
goffi@necton2
parents:
diff changeset
115
goffi@necton2
parents:
diff changeset
116 ** Contact **
goffi@necton2
parents:
diff changeset
117
goffi@necton2
parents:
diff changeset
118 You can contact me on goffi@goffi.org . Yes I know, I don't give my JID ;)
goffi@necton2
parents:
diff changeset
119 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
120
goffi@necton2
parents:
diff changeset
121
goffi@necton2
parents:
diff changeset
122
goffi@necton2
parents:
diff changeset
123 This software is dedicated to Roger Poisson.