annotate README @ 541:e903a9f79172

browser_side (plugin OTR): also ask for a confirmation if the user has no private key and initiates an OTR session
author souliane <souliane@mailoo.org>
date Sun, 07 Sep 2014 23:58:10 +0200
parents ee38b6a87692
children fb20b1423143
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
385
f2c380af7304 version update
Goffi <goffi@goffi.org>
parents: 384
diff changeset
1 Libervia v0.4.0
340
ce5b33f499c5 dates update
Goffi <goffi@goffi.org>
parents: 169
diff changeset
2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011, 2012, 2013, 2014
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
3 (c) Adrien Cossa aka Souliane 2013, 2014
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 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
39
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
40 A big big thank to the authors/contributors of...
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
41
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
42 proxy65:
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
43 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).
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
44 As the original MIT licence allow, the code is reused and sub-licenced until GPL v3 to follow the rest of the code.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
45
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
46 progressbar:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
47 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
48
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
49 twisted:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
50 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
51
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
52 wokkel:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
53 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
54
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
55 wxWidgets & wxPython:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
56 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
57
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
58 Urwid:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
59 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
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
61 Pyjamas:
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
62 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
63
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
64 Pyfeed and Xe:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
65 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
66
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
67 txJSON-RPC:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
68 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
69
168
eb2f7b1560c2 misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents: 166
diff changeset
70 Mutagen:
eb2f7b1560c2 misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents: 166
diff changeset
71 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
72
526
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
73 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
74 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
75 - 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
76 - 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
77 - 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
78 - EventEmitter was coded by Oliver Caldwell (2011-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
79 As the original licences allow, the code is reused and sub-licenced until GPL v3 to follow the rest of the code.
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
80
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
81 pictures found in frontends/src/wix/images/crystal/:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
82 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
83 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
84
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
85 pictures found in frontends/src/wix/images/cards/ and /public/cards in Libervia:
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
86 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 licence, available under the same conditions.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
87
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
88 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
89
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
90 and the others:
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
91 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
92
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
93 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
94
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
95
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
96 ** CONTRIBUTORS **
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 Salut à Toi has received contributions from:
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
99
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
100 - 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
101
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
102 - 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
103
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
104 - 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
105
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
106 - 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
107
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
108 - 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
109
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
110 - 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
111
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
112 Many thanks to them.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
113
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
114 A big thanks also to all the maintainers of SàT packages
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
115
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
116
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
117 ** CONTACT **
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
118
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
119 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
120
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
121 Goffi:
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
122 - goffi@goffi.org (e-mail)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
123 - goffi@jabber.fr (jid)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
124 - http://www.goffi.org (blog, with fresh news about SàT)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
125
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
126 Souliane:
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
127 - souliane@mailoo.org (e-mail)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
128 - souliane@libervia.org (jid)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
129
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
130 You'll find the latest version and other stuffs on *.goffi.org websites:
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
131
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
132 - wiki (wiki.goffi.org), in french & english so far
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
133 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
134 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
135 - mailing lists (lists.goffi.org)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
136
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
137 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
138
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
139
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
140
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
141 This software is dedicated to Roger Poisson.