Mercurial > libervia-backend
annotate README @ 75:7322a41f8a8e
Basic user joined/left management
- plugin XEP-0045: user joined./left signal is sended
- wix: user are adder/removed when these signals are catched
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Mon, 29 Mar 2010 16:54:53 +1100 |
| parents | a5b5fb5fc9fd |
| children | a566f654929e |
| rev | line source |
|---|---|
| 0 | 1 SàT |
| 57 | 2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010 |
| 0 | 3 |
| 4 SàT is a XMPP (Jabber) client. | |
| 5 | |
| 6 | |
| 7 | |
| 8 | |
| 9 | |
| 10 ** LICENSE ** | |
| 11 | |
| 12 SàT is free software: you can redistribute it and/or modify | |
| 13 it under the terms of the GNU General Public License as published by | |
| 14 the Free Software Foundation, either version 3 of the License, or | |
| 15 (at your option) any later version. | |
| 16 | |
| 17 SàT is distributed in the hope that it will be useful, | |
| 18 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 20 GNU General Public License for more details. | |
| 21 | |
| 22 You should have received a copy of the GNU General Public License | |
| 23 along with SàT. If not, see <http://www.gnu.org/licenses/>. | |
| 24 | |
| 25 | |
| 26 | |
| 27 It is currently in a very alpha stage, and absolutely not usable for everyday use, use at your own risks ! | |
| 28 | |
| 29 | |
| 30 | |
| 31 | |
| 32 | |
| 33 ** WTF ? ** | |
| 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. | |
| 35 | |
| 36 For the moment, the frontends are: | |
| 37 | |
| 38 * wix: a wxwidget frontend, the main graphical frontend | |
| 39 * sortilège: a ncurses client, for screen lovers | |
| 40 * jp: the command line toolkit. The tool for geeks by geeks | |
| 41 | |
| 42 other frontends planed in the near future: | |
| 43 | |
| 44 * a web frontend | |
| 45 * a KDE 4 frontend, as KDE is my main desktop environment | |
| 46 | |
| 47 | |
| 48 | |
| 49 | |
| 50 | |
| 51 ** How to use it ? ** | |
| 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 | 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 | 56 There will probably be a wiki doc in the future. |
| 57 | |
| 58 | |
| 59 | |
| 60 | |
| 61 | |
| 62 ** Misc ** | |
| 63 | |
| 64 -- Shortcuts for sortilège (temporary): | |
| 65 C-L: access contact list (enter to valid) | |
| 66 F2: Show/Hide contact list | |
| 67 C-S: Short representation of contacts in chat window | |
| 68 C-C: Use colors... or not | |
| 69 C-T: Timestamp | |
| 70 C-X: Leave | |
| 71 -- | |
| 72 | |
| 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. | |
| 74 jp stands for Jabber coPy or JumP. If you look well, you can also find my initials ;) | |
| 75 sortilège means "spell" in french, and it is ncurses based... | |
| 76 wix come of course from the WX of wxwidgets and just sound cool :). | |
| 77 | |
| 78 | |
| 31 | 79 ** /!\ Privacy warning /!\ ** |
| 0 | 80 |
| 31 | 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 . |
| 82 The IP are not collected. Future releases will probably come with a warning about this and an easy way to avoid it. | |
| 0 | 83 |
| 84 | |
| 85 ** Credit ** | |
| 86 | |
| 87 proxy65: | |
| 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). | |
| 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 ! | |
| 90 | |
| 91 progressbar: | |
| 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 | |
| 93 | |
| 94 twisted: | |
| 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 | |
| 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 |
| 57 | 103 pictures found in frontends/wix/images/crystal/: |
|
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 | 107 and the others: |
| 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. | |
| 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 | 112 |
| 113 | |
| 114 | |
| 115 | |
| 116 ** Contact ** | |
| 117 | |
| 118 You can contact me on goffi@goffi.org . Yes I know, I don't give my JID ;) | |
| 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). | |
| 120 | |
| 121 | |
| 122 | |
| 123 This software is dedicated to Roger Poisson. | |
| 57 | 124 |