Mercurial > libervia-web

comparison README @ 60:d9f4a3256da8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added README
author Goffi <goffi@goffi.org>
date Mon, 30 May 2011 16:13:07 +0200
parents
children ddfcc4cb6cee
comparison
equal deleted inserted replaced
59:d0fa4e96a5e4 60:d9f4a3256da8
1 Libervia v0.2.0
2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011
3
4 Libervia is a frontend for SàT
5 SàT is a XMPP (Jabber) client.
6
7 ** LICENSE **
8
9 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 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
13
14 Libervia is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU Affero General Public License for more details.
18
19 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
22
23
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
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)
33
34 ** How to use it ? **
35
36 Refer to the wiki for installation/use instructions:
37 http://wiki.goffi.org/wiki/Libervia
38
39
40
41 ** Credit **
42
43 All the credits are the same than the ones for "Salut à Toi", as it is a global project.
44
45 A big big thank to the authors/contributors of...
46
47 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).
49 As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code.
50
51 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.
53
54 twisted:
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 :).
56
57 wokkel:
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.
59
60 wxWidgets & wxPython:
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.
62
63 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.
65
66 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.
68
69 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.
71
72 txJSON-RPC:
73 Libervia use txJSON-RPC (https://launchpad.net/txjsonrpc), a twisted library to communicate with the browser's javascript throught JSON-RPC
74
75 pictures found in frontends/src/wix/images/crystal/:
76 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).
77 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
78
79 pictures found in frontends/src/wix/images/cards/ and /public/cards in Libervia:
80 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.
81
82 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
83
84 and the others:
85 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.
86
87 If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
88
89
90
91
92
93 ** Contact **
94
95 You can contact me on goffi@goffi.org (e-mail) or goffi@jabber.fr (jid)
96 You'll find the latest version and other stuffs on my *.goffi.org websites:
97 - wiki (wiki.goffi.org), in french & english so far
98 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
99 - blog (www.goffi.org) for latest news (in french)
100 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
101 - various mailing lists (lists.goffi.org) are about to be created
102
103
104
105 This software is dedicated to Roger Poisson.
106