annotate README @ 207:a43b66af3872

browser side: changed bubbles background color
author Goffi <goffi@goffi.org>
date Thu, 27 Jun 2013 22:09:34 +0200
parents 732ed69ffe11
children ce5b33f499c5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
169
732ed69ffe11 version update (release time)
Goffi <goffi@goffi.org>
parents: 168
diff changeset
1 Libervia v0.3.0
165
9763dec220ed dates update
Goffi <goffi@goffi.org>
parents: 136
diff changeset
2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011, 2012, 2013
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
3
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
4 Libervia is a frontend for SàT
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
5 SàT is a XMPP (Jabber) client.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
6
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
7 ** LICENSE **
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
8
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
9 Libervia is free software: you can redistribute it and/or modify
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
10 it under the terms of the GNU Affero General Public License as
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
11 the Free Software Foundation, either version 3 of the License, or
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
12 (at your option) any later version.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
13
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
14 Libervia is distributed in the hope that it will be useful,
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
17 GNU Affero General Public License for more details.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
18
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
19 You should have received a copy of the GNU Affero General Public License
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
20 along with Libervia. If not, see <http://www.gnu.org/licenses/>.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
21
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
22
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
23
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
24 It is currently in a very alpha stage, and absolutely not usable for everyday use, use at your own risks !
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
25
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
26
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
27
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
28
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
29
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
30 ** WTF ? **
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
31
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
32 Libervia is a web frontend for the "Salut à Toi" (SàT) XMPP client. Please check SàT for more information (it's anyway needed to run libervia)
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
33
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
34 ** How to use it ? **
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
35
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
36 Refer to the wiki for installation/use instructions:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
37 http://wiki.goffi.org/wiki/Libervia
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
38
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
39
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
40
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
41 ** Credit **
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
42
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
43 All the credits are the same than the ones for "Salut à Toi", as it is a global project.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
44
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
45 A big big thank to the authors/contributors of...
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
46
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
47 proxy65:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
48 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).
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
49 As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
50
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
51 progressbar:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
52 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.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
53
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
54 twisted:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
55 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 :).
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
56
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
57 wokkel:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
58 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.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
59
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
60 wxWidgets & wxPython:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
61 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.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
62
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
63 Urwid:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
64 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.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
65
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
66 Pyjamas:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
67 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.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
68
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
69 Pyfeed and Xe:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
70 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.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
71
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
72 txJSON-RPC:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
73 Libervia use txJSON-RPC (https://launchpad.net/txjsonrpc), a twisted library to communicate with the browser's javascript throught JSON-RPC
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
74
168
eb2f7b1560c2 misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents: 166
diff changeset
75 Mutagen:
eb2f7b1560c2 misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents: 166
diff changeset
76 Mutagen (https://code.google.com/p/mutagen/) is an audio metadata handling library, it's use by the radiocol plugin.
eb2f7b1560c2 misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents: 166
diff changeset
77
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
78 pictures found in frontends/src/wix/images/crystal/:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
79 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).
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
80 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
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
81
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
82 pictures found in frontends/src/wix/images/cards/ and /public/cards in Libervia:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
83 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.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
84
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
85 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
86
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
87 and the others:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
88 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.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
89
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
90 If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
91
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
92 ** Contributors **
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
93
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
94 Salut à Toi has received contributions from:
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
95
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
96 - 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.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
97
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
98 - Xavier Maillard <xavier@maillard.im>: bugs fixes. He's following the project for a while, maybe a future frontend contributor ?
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
99
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
100 - Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>: bugs fixes. A guy always around XMPP projects, he plan to work on a non D-Bus bridge.
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
101
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
102 - Matthieu Rakotojaona <matthieu.rakotojaona@gmail.com>: English translation of the social contract. A great quality translation !
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
103
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
104 Many thanks to them.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
105
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
106 ** Contact **
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
107
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
108 You can contact me on goffi@goffi.org (e-mail) or goffi@jabber.fr (jid)
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
109 You'll find the latest version and other stuffs on my *.goffi.org websites:
166
4d177e3f6285 misc: added presentation website to README
Goffi <goffi@goffi.org>
parents: 165
diff changeset
110 - presentation (sat.goffi.org) the project presentation site
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
111 - wiki (wiki.goffi.org), in french & english so far
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
112 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
113 - blog (www.goffi.org) for latest news (in french)
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
114 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
115 - various mailing lists (lists.goffi.org) are about to be created
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
116
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
117
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
118
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
119 This software is dedicated to Roger Poisson.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
120