Mercurial > libervia-backend
annotate README @ 506:2e43c74815ad
plugin text commands: Text commands is a new plugin that bring IRC-like commands
- Text commands catch message sent, and check commands starting by /
- /nick command is managed
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Thu, 27 Sep 2012 00:54:42 +0200 |
| parents | e0d1eed4a46b |
| children | 52ab19ea940e |
| rev | line source |
|---|---|
|
357
d98b7391d76c
Changed version number to dev version
Goffi <goffi@goffi.org>
parents:
348
diff
changeset
|
1 SàT v0.2.0D |
| 459 | 2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011, 2012 |
| 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 | |
|
480
2a072735e459
Licence modification: the full project is now under AGPL v3+ instead of GPL v3+
Goffi <goffi@goffi.org>
parents:
459
diff
changeset
|
13 it under the terms of the GNU Affero General Public License as published by |
| 0 | 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 | |
|
480
2a072735e459
Licence modification: the full project is now under AGPL v3+ instead of GPL v3+
Goffi <goffi@goffi.org>
parents:
459
diff
changeset
|
20 GNU Affero General Public License for more details. |
| 0 | 21 |
|
480
2a072735e459
Licence modification: the full project is now under AGPL v3+ instead of GPL v3+
Goffi <goffi@goffi.org>
parents:
459
diff
changeset
|
22 You should have received a copy of the GNU Affero General Public License |
| 0 | 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 | |
| 181 | 39 * primitivus: a console interface client, for screen lovers |
| 0 | 40 * jp: the command line toolkit. The tool for geeks by geeks |
| 348 | 41 * libervia: the web frontend. It's in a different package, check libervia on the wiki: http://wiki.goffi.org/wiki/Libervia |
| 0 | 42 |
| 43 other frontends planed in the near future: | |
| 44 | |
| 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 |
|
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 | 58 There will probably be a wiki doc in the future. |
| 59 | |
| 60 | |
| 61 | |
| 62 | |
| 63 | |
| 64 ** Misc ** | |
| 65 | |
| 348 | 66 You can find Primitivus shortcuts on the wiki: |
| 67 http://wiki.goffi.org/wiki/Primitivus | |
| 68 | |
| 181 | 69 -- Shortcuts for Primitivus (temporary): |
| 70 C stands for "Ctrl" | |
| 71 M stands for Meta wich is usually the "Alt" key | |
| 72 S stands for "Shift" | |
| 73 | |
| 74 ##GENERAL## | |
| 75 [tab] and/or arrows: change focus | |
| 76 C-x: Quit | |
| 77 M-m: (un)hide menu | |
| 78 C-n: see next notification | |
| 79 C-s: temporarly (un)hide popup window | |
| 80 F2: (un)hide the contact list | |
| 81 | |
| 82 ##CHAT WINDOW## | |
| 83 M-p: (un)hide presents panel in group chat | |
| 84 M-t: (un)hide timestamp | |
| 85 M-n: (not) use short nicks | |
| 86 M-l: (un)hide window's decoration | |
| 87 M-s: change apperance of subject, switch between: | |
| 88 - one line (subject is clipped if too long) | |
| 89 - full subject displayed | |
| 90 - subject hidden | |
| 91 | |
| 92 ##EDITION ZONE## | |
| 93 C-a or [home]: place the cursor at the begining of the line | |
| 94 C-e or [end]: place the cursor at the end of the line | |
| 95 C-k: kill (delete) everything at the right of the cursor | |
| 96 C-w: delete the last word | |
| 97 S-[tab]: Do context completion | |
| 98 | |
| 99 Note that the mouse can be used | |
| 0 | 100 -- |
| 101 | |
| 102 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 | 103 jp stands for "Jabber coPy" or "JumP". If you look well, you can also find my initials ;) |
| 104 Primitivus is based on Urwid, and, according to their FAQ, "ur" is a german prefix for "ancestral or primal" (primitivus is latin word) | |
| 0 | 105 wix come of course from the WX of wxwidgets and just sound cool :). |
| 106 | |
| 107 | |
| 31 | 108 ** /!\ Privacy warning /!\ ** |
| 0 | 109 |
| 31 | 110 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 . |
| 111 The IP are not collected. Future releases will probably come with a warning about this and an easy way to avoid it. | |
| 0 | 112 |
| 113 | |
| 114 ** Credit ** | |
| 115 | |
| 181 | 116 A big big thank to the authors/contributors of... |
| 117 | |
| 0 | 118 proxy65: |
| 119 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 | 120 As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code. |
| 0 | 121 |
| 122 progressbar: | |
| 181 | 123 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 | 124 |
| 125 twisted: | |
| 348 | 126 SàT is heavily based on the twisted framework (http://twistedmatrix.com/trac/), a very great tool which offer a lot of protocols management. There are too many contributors to name them here, so take a look on the website :). |
| 0 | 127 |
|
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
128 wokkel: |
|
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
129 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
|
130 |
|
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
131 wxWidgets & wxPython: |
| 181 | 132 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. |
| 133 | |
| 134 Urwid: | |
| 135 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
|
136 |
| 348 | 137 Pyjamas: |
| 138 Libervia is built with a Pyjamas (http://pyjs.org), a Google Web Toolkit port for python, including Python to Javascript compiler, and Pyjamas Desktop which allow to execute the same application on the desktop or throught a browser. It's really an amazing tool. | |
| 139 | |
| 140 Pyfeed and Xe: | |
| 141 SàT core and Libervia use pyfeed and xe (http://www.blarg.net/%7Esteveha/), 2 libraries made Steve R. Hastings really useful to parse/generate xml stuff as atom feeds. | |
| 142 | |
| 143 txJSON-RPC: | |
| 144 Libervia use txJSON-RPC (https://launchpad.net/txjsonrpc), a twisted library to communicate with the browser's javascript throught JSON-RPC | |
| 145 | |
|
322
2b9b6b6ec717
README: fixed paths, and added personnal jid
Goffi <goffi@goffi.org>
parents:
245
diff
changeset
|
146 pictures found in frontends/src/wix/images/crystal/: |
|
2b9b6b6ec717
README: fixed paths, and added personnal jid
Goffi <goffi@goffi.org>
parents:
245
diff
changeset
|
147 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/src/wix/images/COPYING.LESSER). |
|
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
148 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
|
149 |
| 348 | 150 pictures found in frontends/src/wix/images/cards/ and /public/cards in Libervia: |
|
322
2b9b6b6ec717
README: fixed paths, and added personnal jid
Goffi <goffi@goffi.org>
parents:
245
diff
changeset
|
151 The Tarot cards pictures come from the deck found on wikicommons (the script used to cut them is available at frontend/src/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. |
| 181 | 152 |
| 153 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture. | |
| 154 | |
| 0 | 155 and the others: |
| 181 | 156 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 | 157 |
|
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
158 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
|
159 |
|
482
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
160 ** Contributors ** |
| 0 | 161 |
|
482
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
162 Salut à Toi has received contributions from: |
|
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
163 |
|
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
164 - Adrien Vigneron <adrienvigneron@mailoo.org>: huge work on Libervia's CSS, SàT Logo (the mascot is its work), and Quiz game graphisms. He's friendly and talented, his work is really appreciated. |
| 0 | 165 |
|
482
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
166 - Xavier Maillard <xavier@maillard.im>: bugs fixes. He's following the project for a while, maybe a future frontend contributor ? |
| 0 | 167 |
|
482
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
168 - Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>: bugs fixes. A guy always around XMPP projects, he plan to work on a non D-Bus bridge. |
|
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
169 |
|
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
170 - Matthieu Rakotojaona <matthieu.rakotojaona@gmail.com>: English translation of the social contract. A great quality translation ! |
|
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
171 |
|
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
172 Many thanks to them. |
| 0 | 173 |
| 174 ** Contact ** | |
| 175 | |
|
322
2b9b6b6ec717
README: fixed paths, and added personnal jid
Goffi <goffi@goffi.org>
parents:
245
diff
changeset
|
176 You can contact me on goffi@goffi.org (e-mail) or goffi@jabber.fr (jid) |
|
238
83d2bc0abf2a
version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents:
228
diff
changeset
|
177 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
|
178 - wiki (wiki.goffi.org), in french & english so far |
|
83d2bc0abf2a
version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents:
228
diff
changeset
|
179 - 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
|
180 - blog (www.goffi.org) for latest news (in french) |
|
83d2bc0abf2a
version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents:
228
diff
changeset
|
181 - 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
|
182 - various mailing lists (lists.goffi.org) are about to be created |
| 0 | 183 |
| 184 | |
| 185 | |
| 186 This software is dedicated to Roger Poisson. | |
| 57 | 187 |