annotate README @ 317:f1f7c94278f2

added plugin XEP-0249: direct MUC invitation
author Goffi <goffi@goffi.org>
date Fri, 06 May 2011 15:33:07 +0200
parents e077f068ff57
children 2b9b6b6ec717
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
245
e077f068ff57 version updated to 0.1.1
Goffi <goffi@goffi.org>
parents: 238
diff changeset
1 SàT v0.1.1
228
b1794cbb88e5 2011 copyright upgrade
Goffi <goffi@goffi.org>
parents: 205
diff changeset
2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011
0
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
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
39 * primitivus: a console interface client, for screen lovers
0
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
238
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
55 A wiki is available online (http://wiki.goffi.org), in french and english so far (I would appreciate any help for other languages). You can also have a look at the bottom of this files (in contact section) for other availables websites.
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
56
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
57 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
58 There will probably be a wiki doc in the future.
goffi@necton2
parents:
diff changeset
59
goffi@necton2
parents:
diff changeset
60
goffi@necton2
parents:
diff changeset
61
goffi@necton2
parents:
diff changeset
62
goffi@necton2
parents:
diff changeset
63
goffi@necton2
parents:
diff changeset
64 ** Misc **
goffi@necton2
parents:
diff changeset
65
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
66 -- Shortcuts for Primitivus (temporary):
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
67 C stands for "Ctrl"
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
68 M stands for Meta wich is usually the "Alt" key
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
69 S stands for "Shift"
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
70
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
71 ##GENERAL##
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
72 [tab] and/or arrows: change focus
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
73 C-x: Quit
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
74 M-m: (un)hide menu
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
75 C-n: see next notification
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
76 C-s: temporarly (un)hide popup window
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
77 F2: (un)hide the contact list
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
78
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
79 ##CHAT WINDOW##
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
80 M-p: (un)hide presents panel in group chat
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
81 M-t: (un)hide timestamp
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
82 M-n: (not) use short nicks
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
83 M-l: (un)hide window's decoration
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
84 M-s: change apperance of subject, switch between:
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
85 - one line (subject is clipped if too long)
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
86 - full subject displayed
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
87 - subject hidden
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
88
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
89 ##EDITION ZONE##
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
90 C-a or [home]: place the cursor at the begining of the line
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
91 C-e or [end]: place the cursor at the end of the line
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
92 C-k: kill (delete) everything at the right of the cursor
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
93 C-w: delete the last word
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
94 S-[tab]: Do context completion
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
95
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
96 Note that the mouse can be used
0
goffi@necton2
parents:
diff changeset
97 --
goffi@necton2
parents:
diff changeset
98
goffi@necton2
parents:
diff changeset
99 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.
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
100 jp stands for "Jabber coPy" or "JumP". If you look well, you can also find my initials ;)
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
101 Primitivus is based on Urwid, and, according to their FAQ, "ur" is a german prefix for "ancestral or primal" (primitivus is latin word)
0
goffi@necton2
parents:
diff changeset
102 wix come of course from the WX of wxwidgets and just sound cool :).
goffi@necton2
parents:
diff changeset
103
goffi@necton2
parents:
diff changeset
104
31
7b34ffa2ff45 Updated README and added CHANGELOG
Goffi <goffi@goffi.org>
parents: 27
diff changeset
105 ** /!\ Privacy warning /!\ **
0
goffi@necton2
parents:
diff changeset
106
31
7b34ffa2ff45 Updated README and added CHANGELOG
Goffi <goffi@goffi.org>
parents: 27
diff changeset
107 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
108 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
109
goffi@necton2
parents:
diff changeset
110
goffi@necton2
parents:
diff changeset
111 ** Credit **
goffi@necton2
parents:
diff changeset
112
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
113 A big big thank to the authors/contributors of...
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
114
0
goffi@necton2
parents:
diff changeset
115 proxy65:
goffi@necton2
parents:
diff changeset
116 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).
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
117 As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code.
0
goffi@necton2
parents:
diff changeset
118
goffi@necton2
parents:
diff changeset
119 progressbar:
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
120 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.
0
goffi@necton2
parents:
diff changeset
121
goffi@necton2
parents:
diff changeset
122 twisted:
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
123 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 :).
0
goffi@necton2
parents:
diff changeset
124
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
125 wokkel:
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
126 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
127
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
128 wxWidgets & wxPython:
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
129 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.
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
130
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
131 Urwid:
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
132 Primitivus is based on Urwid (http://excess.org/urwid/) which saved me a lot of time. It's really a great library to easily make a sophisticated interface.
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
133
57
a5b5fb5fc9fd updated README and copyright note
Goffi <goffi@goffi.org>
parents: 31
diff changeset
134 pictures found in frontends/wix/images/crystal/:
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
135 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).
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
136 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
137
205
92e4ddd580ae version change before release
Goffi <goffi@goffi.org>
parents: 181
diff changeset
138 pictures found in frontends/wix/images/cards/ :
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
139 The Tarot cards pictures come from the deck found on wikicommons (the script used to cut them is available at frontend/wix/images/split_card.sh), and available at http://upload.wikimedia.org/wikipedia/commons/8/8d/Tarotcards.jpg under Creative Commons BY-SA. The authors shown on the site are Piast and Svick. The splitted cards are, according to the license, available under the same conditions.
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
140
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
141 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
142
0
goffi@necton2
parents:
diff changeset
143 and the others:
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
144 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/), and also XFCE (http://www.xfce.org), etc. Thanks thanks thanks, thank to everybody in the Free (Libre) chain for making a part of the dream.
0
goffi@necton2
parents:
diff changeset
145
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
146 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
147
0
goffi@necton2
parents:
diff changeset
148
goffi@necton2
parents:
diff changeset
149
goffi@necton2
parents:
diff changeset
150
goffi@necton2
parents:
diff changeset
151
goffi@necton2
parents:
diff changeset
152 ** Contact **
goffi@necton2
parents:
diff changeset
153
goffi@necton2
parents:
diff changeset
154 You can contact me on goffi@goffi.org . Yes I know, I don't give my JID ;)
238
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
155 You'll find the latest version and other stuffs on my *.goffi.org websites:
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
156 - wiki (wiki.goffi.org), in french & english so far
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
157 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
158 - blog (www.goffi.org) for latest news (in french)
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
159 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
160 - various mailing lists (lists.goffi.org) are about to be created
0
goffi@necton2
parents:
diff changeset
161
goffi@necton2
parents:
diff changeset
162
goffi@necton2
parents:
diff changeset
163
goffi@necton2
parents:
diff changeset
164 This software is dedicated to Roger Poisson.
57
a5b5fb5fc9fd updated README and copyright note
Goffi <goffi@goffi.org>
parents: 31
diff changeset
165