Mercurial > libervia-backend
annotate README @ 229:0154059ecf3f
distutils: added MANIFEST.in
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Wed, 05 Jan 2011 21:48:35 +0100 |
| parents | b1794cbb88e5 |
| children | 83d2bc0abf2a |
| rev | line source |
|---|---|
| 205 | 1 SàT v0.0.3 |
| 228 | 2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011 |
| 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 | |
| 181 | 39 * primitivus: a console interface client, for screen lovers |
| 0 | 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 | |
| 181 | 64 -- Shortcuts for Primitivus (temporary): |
| 65 C stands for "Ctrl" | |
| 66 M stands for Meta wich is usually the "Alt" key | |
| 67 S stands for "Shift" | |
| 68 | |
| 69 ##GENERAL## | |
| 70 [tab] and/or arrows: change focus | |
| 71 C-x: Quit | |
| 72 M-m: (un)hide menu | |
| 73 C-n: see next notification | |
| 74 C-s: temporarly (un)hide popup window | |
| 75 F2: (un)hide the contact list | |
| 76 | |
| 77 ##CHAT WINDOW## | |
| 78 M-p: (un)hide presents panel in group chat | |
| 79 M-t: (un)hide timestamp | |
| 80 M-n: (not) use short nicks | |
| 81 M-l: (un)hide window's decoration | |
| 82 M-s: change apperance of subject, switch between: | |
| 83 - one line (subject is clipped if too long) | |
| 84 - full subject displayed | |
| 85 - subject hidden | |
| 86 | |
| 87 ##EDITION ZONE## | |
| 88 C-a or [home]: place the cursor at the begining of the line | |
| 89 C-e or [end]: place the cursor at the end of the line | |
| 90 C-k: kill (delete) everything at the right of the cursor | |
| 91 C-w: delete the last word | |
| 92 S-[tab]: Do context completion | |
| 93 | |
| 94 Note that the mouse can be used | |
| 0 | 95 -- |
| 96 | |
| 97 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 | 98 jp stands for "Jabber coPy" or "JumP". If you look well, you can also find my initials ;) |
| 99 Primitivus is based on Urwid, and, according to their FAQ, "ur" is a german prefix for "ancestral or primal" (primitivus is latin word) | |
| 0 | 100 wix come of course from the WX of wxwidgets and just sound cool :). |
| 101 | |
| 102 | |
| 31 | 103 ** /!\ Privacy warning /!\ ** |
| 0 | 104 |
| 31 | 105 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 . |
| 106 The IP are not collected. Future releases will probably come with a warning about this and an easy way to avoid it. | |
| 0 | 107 |
| 108 | |
| 109 ** Credit ** | |
| 110 | |
| 181 | 111 A big big thank to the authors/contributors of... |
| 112 | |
| 0 | 113 proxy65: |
| 114 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 | 115 As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code. |
| 0 | 116 |
| 117 progressbar: | |
| 181 | 118 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 | 119 |
| 120 twisted: | |
| 181 | 121 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 | 122 |
|
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
123 wokkel: |
|
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
124 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
|
125 |
|
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
126 wxWidgets & wxPython: |
| 181 | 127 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. |
| 128 | |
| 129 Urwid: | |
| 130 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
|
131 |
| 57 | 132 pictures found in frontends/wix/images/crystal/: |
| 181 | 133 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
|
134 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
|
135 |
| 205 | 136 pictures found in frontends/wix/images/cards/ : |
| 181 | 137 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. |
| 138 | |
| 139 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture. | |
| 140 | |
| 0 | 141 and the others: |
| 181 | 142 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 | 143 |
|
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
144 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
|
145 |
| 0 | 146 |
| 147 | |
| 148 | |
| 149 | |
| 150 ** Contact ** | |
| 151 | |
| 152 You can contact me on goffi@goffi.org . Yes I know, I don't give my JID ;) | |
| 153 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). | |
| 154 | |
| 155 | |
| 156 | |
| 157 This software is dedicated to Roger Poisson. | |
| 57 | 158 |