comparison README @ 384:8bb9c878b7e3

README update
author Goffi <goffi@goffi.org>
date Wed, 26 Feb 2014 14:00:07 +0100
parents ce5b33f499c5
children f2c380af7304
comparison
equal deleted inserted replaced
383:b90744ec426e 384:8bb9c878b7e3
1 Libervia v0.3.0 1 Libervia 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 4
4 Libervia is a frontend for SàT 5 Libervia is a frontend for SàT
5 SàT is a XMPP (Jabber) client. 6 SàT is a XMPP (Jabber) client.
6 7
7 ** LICENSE ** 8 ** LICENCE **
8 9
9 Libervia is free software: you can redistribute it and/or modify 10 Libervia is free software: you can redistribute it and/or modify
10 it under the terms of the GNU Affero General Public License as 11 it under the terms of the GNU Affero General Public License as
11 the Free Software Foundation, either version 3 of the License, or 12 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version. 13 (at your option) any later version.
18 19
19 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
20 along with Libervia. If not, see <http://www.gnu.org/licenses/>. 21 along with Libervia. If not, see <http://www.gnu.org/licenses/>.
21 22
22 23
23 24 ** ABOUT **
24 It is currently in a very alpha stage, and absolutely not usable for everyday use, use at your own risks !
25
26
27
28
29
30 ** WTF ? **
31 25
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) 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)
33 27
34 ** How to use it ? ** 28 ** How to use it ? **
35 29
36 Refer to the wiki for installation/use instructions: 30 Refer to the wiki for installation/use instructions:
37 http://wiki.goffi.org/wiki/Libervia 31 http://wiki.goffi.org/wiki/Libervia
38 32
33 refer to SàT README for more informations
39 34
40 35
41 ** Credit ** 36 ** CREDIT **
42 37
43 All the credits are the same than the ones for "Salut à Toi", as it is a global project. 38 All the credits are the same than the ones for "Salut à Toi", as it is a global project.
44 39
45 A big big thank to the authors/contributors of... 40 A big big thank to the authors/contributors of...
46 41
47 proxy65: 42 proxy65:
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). 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).
49 As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code. 44 As the original MIT licence allow, the code is reused and sub-licenced until GPL v3 to follow the rest of the code.
50 45
51 progressbar: 46 progressbar:
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. 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.
53 48
54 twisted: 49 twisted:
62 57
63 Urwid: 58 Urwid:
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. 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.
65 60
66 Pyjamas: 61 Pyjamas:
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. 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.
68 63
69 Pyfeed and Xe: 64 Pyfeed and Xe:
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. 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.
71 66
72 txJSON-RPC: 67 txJSON-RPC:
78 pictures found in frontends/src/wix/images/crystal/: 73 pictures found in frontends/src/wix/images/crystal/:
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). 74 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).
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 75 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
81 76
82 pictures found in frontends/src/wix/images/cards/ and /public/cards in Libervia: 77 pictures found in frontends/src/wix/images/cards/ and /public/cards in Libervia:
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. 78 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.
84 79
85 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture. 80 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
86 81
87 and the others: 82 and the others:
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. 83 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.
89 84
90 If I forgot any credit (and I probably have), please contact me (mail below) to fix it. 85 If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
91 86
92 ** Contributors ** 87
88 ** CONTRIBUTORS **
93 89
94 Salut à Toi has received contributions from: 90 Salut à Toi has received contributions from:
95 91
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. 92 - 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.
97 93
98 - Xavier Maillard <xavier@maillard.im>: bugs fixes. He's following the project for a while, maybe a future frontend contributor ? 94 - Xavier Maillard <xavier@maillard.im>: bugs fixes. He's following the project for a while, maybe a future frontend contributor ?
99 95
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. 96 - 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.
101 97
102 - Matthieu Rakotojaona <matthieu.rakotojaona@gmail.com>: English translation of the social contract. A great quality translation ! 98 - Matthieu Rakotojaona <matthieu.rakotojaona@gmail.com>: english translation of the social contract. A great quality translation !
99
100 - Thomas Preud'homme <robotux@debian.org>: bugs fixes. He's also one the maintainer of the Debian package.
101
102 - Dal <kedals0@gmail.com>: profiles management, argparse refactoring in jp
103 103
104 Many thanks to them. 104 Many thanks to them.
105 105
106 ** Contact ** 106 A big thanks also to all the maintainers of SàT packages
107 107
108 You can contact me on goffi@goffi.org (e-mail) or goffi@jabber.fr (jid) 108
109 You'll find the latest version and other stuffs on my *.goffi.org websites: 109 ** CONTACT **
110 - presentation (sat.goffi.org) the project presentation site 110
111 You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually:
112
113 Goffi:
114 - goffi@goffi.org (e-mail)
115 - goffi@jabber.fr (jid)
116 - http://www.goffi.org (blog, with fresh news about SàT)
117
118 Souliane:
119 - souliane@mailoo.org (e-mail)
120 - souliane@libervia.org (jid)
121
122 You'll find the latest version and other stuffs on *.goffi.org websites:
123
111 - wiki (wiki.goffi.org), in french & english so far 124 - wiki (wiki.goffi.org), in french & english so far
112 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects) 125 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
113 - blog (www.goffi.org) for latest news (in french)
114 - bugtracker (bugs.goffi.org) to report any problem or give suggestions 126 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
115 - various mailing lists (lists.goffi.org) are about to be created 127 - mailing lists (lists.goffi.org)
128
129 and the official SàT website is at http://www.salut-a-toi.org
116 130
117 131
118 132
119 This software is dedicated to Roger Poisson. 133 This software is dedicated to Roger Poisson.
120