annotate README @ 753:76a9c074327b

browser_side (contact_panel): fixes contact box update
author souliane <souliane@mailoo.org>
date Tue, 24 Nov 2015 11:00:26 +0100
parents 03e9fe91081c
children b3a2c34320e6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
551
9b217e14fc6a version update
Goffi <goffi@goffi.org>
parents: 545
diff changeset
1 Libervia v0.5.1
685
9877607c719a 2015 copyright dates update
Goffi <goffi@goffi.org>
parents: 551
diff changeset
2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
9877607c719a 2015 copyright dates update
Goffi <goffi@goffi.org>
parents: 551
diff changeset
3 (c) Adrien Cossa aka Souliane 2013, 2014, 2015
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
4
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
5 Libervia is a frontend for SàT
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
6 SàT is a XMPP (Jabber) client.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
7
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
8 ** LICENCE **
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
9
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
10 Libervia is free software: you can redistribute it and/or modify
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
11 it under the terms of the GNU Affero General Public License as
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
12 the Free Software Foundation, either version 3 of the License, or
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
13 (at your option) any later version.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
14
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
15 Libervia is distributed in the hope that it will be useful,
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
18 GNU Affero General Public License for more details.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
19
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
20 You should have received a copy of the GNU Affero General Public License
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
21 along with Libervia. If not, see <http://www.gnu.org/licenses/>.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
22
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
23
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
24 ** ABOUT **
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
25
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
26 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
27
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
28 ** How to use it ? **
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
29
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
30 Refer to the wiki for installation/use instructions:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
31 http://wiki.goffi.org/wiki/Libervia
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
32
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
33 refer to SàT README for more informations
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
34
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
35
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
36 ** CREDIT **
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
37
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
38 A big big thank to the authors/contributors of...
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
39
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
40 proxy65:
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
41 SàT (plugin_xep_0065) use nearly all the code from proxy65 (http://code.google.com/p/proxy65/) which was coded by Dave Smith (2002-2004) and maintained by Fabio Forno (2007-2008).
714
03e9fe91081c browser_side: use favico.js to display alerts counter
souliane <souliane@mailoo.org>
parents: 685
diff changeset
42 As the original MIT licence allows, the code is reused and sublicenced under GPL v3 to follow the rest of the code.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
43
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
44 progressbar:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
45 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
46
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
47 twisted:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
48 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
49
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
50 wokkel:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
51 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
52
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
53 wxWidgets & wxPython:
714
03e9fe91081c browser_side: use favico.js to display alerts counter
souliane <souliane@mailoo.org>
parents: 685
diff changeset
54 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.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
55
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
56 Urwid:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
57 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
58
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
59 Pyjamas:
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
60 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 through a browser. It's really an amazing tool.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
61
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
62 Pyfeed and Xe:
714
03e9fe91081c browser_side: use favico.js to display alerts counter
souliane <souliane@mailoo.org>
parents: 685
diff changeset
63 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.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
64
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
65 txJSON-RPC:
714
03e9fe91081c browser_side: use favico.js to display alerts counter
souliane <souliane@mailoo.org>
parents: 685
diff changeset
66 Libervia use txJSON-RPC (https://launchpad.net/txjsonrpc), a twisted library to communicate with the browser's javascript throught JSON-RPC.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
67
168
eb2f7b1560c2 misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents: 166
diff changeset
68 Mutagen:
eb2f7b1560c2 misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents: 166
diff changeset
69 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
70
526
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
71 otr.js and its dependencies Big Integer Library, CryptoJS, EventEmitter:
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
72 Libervia frontend uses otr.js and its dependencies:
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
73 - otr.js was coded by Arlo Breault (2014) and is released under the Mozilla Public License Version 2.0
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
74 - Big Integer Library was coded by Leemon Baird (2000-2013) and is in the public domain
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
75 - CryptoJS was coded by Jeff Mott (2009-2013) and is released under the MIT licence
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
76 - EventEmitter was coded by Oliver Caldwell (2011-2013) and is released under the MIT licence
714
03e9fe91081c browser_side: use favico.js to display alerts counter
souliane <souliane@mailoo.org>
parents: 685
diff changeset
77 As the original licences allow, the code is reused and sublicenced under GPL v3 to follow the rest of the code.
03e9fe91081c browser_side: use favico.js to display alerts counter
souliane <souliane@mailoo.org>
parents: 685
diff changeset
78
03e9fe91081c browser_side: use favico.js to display alerts counter
souliane <souliane@mailoo.org>
parents: 685
diff changeset
79 favico.js:
03e9fe91081c browser_side: use favico.js to display alerts counter
souliane <souliane@mailoo.org>
parents: 685
diff changeset
80 Libervia's favicon counter is displayed with favico.js (http://lab.ejci.net/favico.js/), a library by Miroslav Magda which is dual licensed under GPL and MIT.
526
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
81
542
fb20b1423143 README: redirect media credits to sat_media repository (the pictures are no more hosted here)
souliane <souliane@mailoo.org>
parents: 526
diff changeset
82 pictures found in the sat_media repository and used by SàT and Libervia:
fb20b1423143 README: redirect media credits to sat_media repository (the pictures are no more hosted here)
souliane <souliane@mailoo.org>
parents: 526
diff changeset
83 Please read the credits and licence information that are given in the README and COPYING files for each work: http://repos.goffi.org/sat_media/file
60
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:
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
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, thanks to everybody in the Free (Libre) chain for making a part of the dream.
60
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
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
92
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
93 ** CONTRIBUTORS **
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
94
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
95 Salut à Toi has received contributions from:
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
96
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
97 - 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
98
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
99 - 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
100
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
101 - Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>: bugs fixes, Libervia's notification, Libervia as a twisted application plugin. A guy always around XMPP projects, he plan to work on a non D-Bus bridge.
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
102
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
103 - Matthieu Rakotojaona <matthieu.rakotojaona@gmail.com>: english translation of the social contract. A great quality translation !
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
104
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
105 - Thomas Preud'homme <robotux@debian.org>: bugs fixes. He's also one the maintainer of the Debian package.
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
106
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
107 - Dal <kedals0@gmail.com>: profiles management, argparse refactoring in jp
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
108
545
95bdad7041d4 version update
Goffi <goffi@goffi.org>
parents: 542
diff changeset
109 - Matteo Cypriani <mcy@lm7.fr>: jp's mainloop update + doc improvments
95bdad7041d4 version update
Goffi <goffi@goffi.org>
parents: 542
diff changeset
110
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
111 Many thanks to them.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
112
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
113 A big thanks also to all the maintainers of SàT packages
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
114
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
115
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
116 ** CONTACT **
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
117
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
118 You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually:
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
119
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
120 Goffi:
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
121 - goffi@goffi.org (e-mail)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
122 - goffi@jabber.fr (jid)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
123 - http://www.goffi.org (blog, with fresh news about SàT)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
124
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
125 Souliane:
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
126 - souliane@mailoo.org (e-mail)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
127 - souliane@libervia.org (jid)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
128
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
129 You'll find the latest version and other stuffs on *.goffi.org websites:
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
130
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
131 - wiki (wiki.goffi.org), in french & english so far
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
132 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
133 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
134 - mailing lists (lists.goffi.org)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
135
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
136 and the official SàT website is at http://www.salut-a-toi.org
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
137
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
138
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
139
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
140 This software is dedicated to Roger Poisson.