Mercurial > libervia-backend

comparison README @ 871:5d08ab99e8dd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
README and INSTALL updates
author Goffi <goffi@goffi.org>
date Wed, 26 Feb 2014 00:36:34 +0100
parents 4429bd7d5efb
children 1f5ad976fa32
comparison
equal deleted inserted replaced
870:e030460e065e 871:5d08ab99e8dd
1 SàT v0.3.0 1 SàT v0.3.0
2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011, 2012, 2013, 2014 2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011, 2012, 2013, 2014
3 (c) Adrien Cossa aka Souliane 2013, 2014 3 (c) Adrien Cossa aka Souliane 2013, 2014
4 4
5 SàT is a XMPP (Jabber) client. 5 SàT is a XMPP (Jabber) client.
6
7
8
9 6
10 7
11 ** LICENSE ** 8 ** LICENSE **
12 9
13 SàT is free software: you can redistribute it and/or modify 10 SàT is free software: you can redistribute it and/or modify
22 19
23 You should have received a copy of the GNU Affero General Public License 20 You should have received a copy of the GNU Affero General Public License
24 along with SàT. If not, see <http://www.gnu.org/licenses/>. 21 along with SàT. If not, see <http://www.gnu.org/licenses/>.
25 22
26 23
24 ** ABOUT **
27 25
28 It is currently in a very alpha stage, and absolutely not usable for everyday use, use at your own risks ! 26 SàT is a XMPP (Jabber) client, made on a daemon/frontends architecture. Its aim is not only to be an instant messaging client: SàT manage microblogging, file transfer, rich text edition, piping over XMPP, XMPP remote, etc.
29 27 In addition, SàT has been built with ethic in mind, a social contract show the main lines (see CONTRAT_SOCIAL or CONTRAT_SOCIAL_en). We have a lot of debates about the right way to do things, more on a social way than on a technical way (but consider technic too).
30
31
32
33
34 ** WTF ? **
35 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.
36 28
37 For the moment, the frontends are: 29 For the moment, the frontends are:
38 30
39 * wix: a wxwidget frontend, the main graphical frontend 31 * wix: based on WxWidgets, a minimal and old fashioned desktop frontend
40 * primitivus: a console interface client, for screen lovers 32 * primitivus: a console interface client, for screen lovers
41 * jp: the command line toolkit. The tool for geeks by geeks 33 * jp: the powerful command line toolkit.
42 * libervia: the web frontend. It's in a different package, check libervia on the wiki: http://wiki.goffi.org/wiki/Libervia 34 * libervia: the web frontend. It's in a different package, check libervia on the wiki: http://wiki.goffi.org/wiki/Libervia
35 * bellaciao: a Qt frontend at an early development stage
43 36
44 other frontends planed in the near future: 37 other frontends planed in the near future:
45 38
46 * a KDE 4 frontend, as KDE is my main desktop environment 39 * mobile frontends, fuse frontend, etc.
47 40
48 41
42 ** HOW TO USE IT ? **
43
44 For installation instructions, please read the file "INSTALL". Note that SàT is available in several GNU/Linux distributions
45
46 A wiki is available online (http://wiki.goffi.org), in french and english so far (we 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.
49 47
50 48
51 49 ** MISC **
52 ** How to use it ? **
53
54 For installation instructions, please read the file "INSTALL".
55
56 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.
57
58 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).
59 There will probably be a wiki doc in the future.
60
61
62
63
64
65 ** Misc **
66 50
67 To use SàT, you need to have D-Bus daemon launched (http://www.freedesktop.org/wiki/Software/dbus/). If you use X Window, it should already be launched. If your are on a terminal environment without X11 (e.g. on a server) you may have to launch it. You can launch a daemon using the following command: 51 To use SàT, you need to have D-Bus daemon launched (http://www.freedesktop.org/wiki/Software/dbus/). If you use X Window, it should already be launched. If your are on a terminal environment without X11 (e.g. on a server) you may have to launch it. You can launch a daemon using the following command:
68 $ eval `dbus-launch --sh-syntax` 52 $ eval `dbus-launch --sh-syntax`
69 53
70 Be careful to use the same environment variables if you start a new session. 54 Be careful to use the same environment variables if you start a new session.
93 http://wiki.goffi.org/wiki/Primitivus 77 http://wiki.goffi.org/wiki/Primitivus
94 78
95 -- 79 --
96 80
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. 81 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.
98 jp stands for "Jabber coPy" or "JumP". If you look well, you can also find my initials ;) 82 jp stands for "Jabber coPy" or "JumP".
99 Primitivus is based on Urwid, and, according to their FAQ, "ur" is a german prefix for "ancestral or primal" (primitivus is latin word) 83 Primitivus is based on Urwid, and, according to their FAQ, "ur" is a german prefix for "ancestral or primal" (primitivus is latin word)
100 wix come of course from the WX of wxwidgets and just sound cool :). 84 wix come of course from the WX of wxwidgets and just sound cool :).
101 85
102 86
103 ** /!\ Privacy warning /!\ ** 87 ** /!\ PRIVACY WARNING /!\ **
104 88
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 . 89 To make setup easier, SàT ask a 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 will appear in my private Apache logs (in the same way as IP used to download the software), which are automatically saved, but will not be used. Future releases will probably come with a warning about this and an easy way to avoid it. 90 The IP will appear in the private Apache logs (in the same way as IP used to download the software), which are automatically saved, but will not be used. Future releases will probably come with a warning about this and an easy way to avoid it.
107 91
108 92
109 ** Credit ** 93 ** CREDIT **
110 94
111 A big big thank to the authors/contributors of... 95 A big big thank to the authors/contributors of...
112 96
113 proxy65: 97 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). 98 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).
149 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. 133 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.
150 134
151 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture. 135 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
152 136
153 and the others: 137 and the others:
154 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. 138 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, thanks to everybody in the Free (Libre) chain for making a part of the dream.
155 139
156 If I forgot any credit (and I probably have), please contact me (mail below) to fix it. 140 If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
157 141
158 ** Contributors ** 142
143 ** CONTRIBUTORS **
159 144
160 Salut à Toi has received contributions from: 145 Salut à Toi has received contributions from:
161 146
162 - 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. 147 - 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.
163 148
173 158
174 Many thanks to them. 159 Many thanks to them.
175 160
176 A big thanks also to all the maintainers of SàT packages 161 A big thanks also to all the maintainers of SàT packages
177 162
178 ** Contact **
179 163
180 You can contact me on goffi@goffi.org (e-mail) or goffi@jabber.fr (jid) 164 ** CONTACT **
181 You'll find the latest version and other stuffs on my *.goffi.org websites: 165
182 - presentation (sat.goffi.org) the project presentation site 166 You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually:
167
168 Goffi:
169 - goffi@goffi.org (e-mail)
170 - goffi@jabber.fr (jid)
171 - http://www.goffi.org (blog, with fresh news about SàT)
172
173 Souliane:
174 - souliane@mailoo.org (e-mail)
175 - souliane@libervia.org (jid)
176
177 You'll find the latest version and other stuffs on *.goffi.org websites:
178
183 - wiki (wiki.goffi.org), in french & english so far 179 - wiki (wiki.goffi.org), in french & english so far
184 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects) 180 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
185 - blog (www.goffi.org) for latest news (in french)
186 - bugtracker (bugs.goffi.org) to report any problem or give suggestions 181 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
187 - various mailing lists (lists.goffi.org) are about to be created 182 - mailing lists (lists.goffi.org)
183
184 and the official SàT website is at http://www.salut-a-toi.org
188 185
189 186
190 187
191 This software is dedicated to Roger Poisson. 188 This software is dedicated to Roger Poisson.
192