Mercurial > libervia-web
annotate README @ 449:981ed669d3b3
/!\ reorganize all the file hierarchy, move the code and launching script to src:
- browser_side --> src/browser
- public --> src/browser_side/public
- libervia.py --> src/browser/libervia_main.py
- libervia_server --> src/server
- libervia_server/libervia.sh --> src/libervia.sh
- twisted --> src/twisted
- new module src/common
- split constants.py in 3 files:
- src/common/constants.py
- src/browser/constants.py
- src/server/constants.py
- output --> html (generated by pyjsbuild during the installation)
- new option/parameter "data_dir" (-d) to indicates the directory containing html and server_css
- setup.py installs libervia to the following paths:
- src/common --> <LIB>/libervia/common
- src/server --> <LIB>/libervia/server
- src/twisted --> <LIB>/twisted
- html --> <SHARE>/libervia/html
- server_side --> <SHARE>libervia/server_side
- LIBERVIA_INSTALL environment variable takes 2 new options with prompt confirmation:
- clean: remove previous installation directories
- purge: remove building and previous installation directories
You may need to update your sat.conf and/or launching script to update the following options/parameters:
- ssl_certificate
- data_dir
| author | souliane <souliane@mailoo.org> |
|---|---|
| date | Tue, 20 May 2014 06:41:16 +0200 |
| parents | f2c380af7304 |
| children | ee38b6a87692 |
| rev | line source |
|---|---|
| 385 | 1 Libervia v0.4.0 |
| 340 | 2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011, 2012, 2013, 2014 |
| 384 | 3 (c) Adrien Cossa aka Souliane 2013, 2014 |
| 60 | 4 |
| 5 Libervia is a frontend for SàT | |
| 6 SàT is a XMPP (Jabber) client. | |
| 7 | |
| 384 | 8 ** LICENCE ** |
| 60 | 9 |
| 10 Libervia is free software: you can redistribute it and/or modify | |
| 11 it under the terms of the GNU Affero General Public License as | |
| 12 the Free Software Foundation, either version 3 of the License, or | |
| 13 (at your option) any later version. | |
| 14 | |
| 15 Libervia is distributed in the hope that it will be useful, | |
| 16 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 18 GNU Affero General Public License for more details. | |
| 19 | |
| 20 You should have received a copy of the GNU Affero General Public License | |
| 21 along with Libervia. If not, see <http://www.gnu.org/licenses/>. | |
| 22 | |
| 23 | |
| 384 | 24 ** ABOUT ** |
| 60 | 25 |
| 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) | |
| 27 | |
| 28 ** How to use it ? ** | |
| 29 | |
| 30 Refer to the wiki for installation/use instructions: | |
| 31 http://wiki.goffi.org/wiki/Libervia | |
| 32 | |
| 384 | 33 refer to SàT README for more informations |
| 60 | 34 |
| 35 | |
| 384 | 36 ** CREDIT ** |
| 60 | 37 |
| 38 All the credits are the same than the ones for "Salut à Toi", as it is a global project. | |
| 39 | |
| 40 A big big thank to the authors/contributors of... | |
| 41 | |
| 42 proxy65: | |
| 384 | 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). |
| 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 | 45 |
| 46 progressbar: | |
| 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. | |
| 48 | |
| 49 twisted: | |
| 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 :). | |
| 51 | |
| 52 wokkel: | |
| 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. | |
| 54 | |
| 55 wxWidgets & wxPython: | |
| 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. | |
| 57 | |
| 58 Urwid: | |
| 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. | |
| 60 | |
| 61 Pyjamas: | |
| 384 | 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 | 63 |
| 64 Pyfeed and Xe: | |
| 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. | |
| 66 | |
| 67 txJSON-RPC: | |
| 68 Libervia use txJSON-RPC (https://launchpad.net/txjsonrpc), a twisted library to communicate with the browser's javascript throught JSON-RPC | |
| 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 |
| 60 | 73 pictures found in frontends/src/wix/images/crystal/: |
| 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). | |
| 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 | |
| 76 | |
| 77 pictures found in frontends/src/wix/images/cards/ and /public/cards in Libervia: | |
| 384 | 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. |
| 60 | 79 |
| 80 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture. | |
| 81 | |
| 82 and the others: | |
| 384 | 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. |
| 60 | 84 |
| 85 If I forgot any credit (and I probably have), please contact me (mail below) to fix it. | |
| 86 | |
| 384 | 87 |
| 88 ** CONTRIBUTORS ** | |
| 60 | 89 |
|
136
9d7d98954e34
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
131
diff
changeset
|
90 Salut à Toi has received contributions from: |
|
9d7d98954e34
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
131
diff
changeset
|
91 |
|
9d7d98954e34
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
131
diff
changeset
|
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. |
| 60 | 93 |
|
136
9d7d98954e34
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
131
diff
changeset
|
94 - Xavier Maillard <xavier@maillard.im>: bugs fixes. He's following the project for a while, maybe a future frontend contributor ? |
| 60 | 95 |
| 384 | 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. |
| 97 | |
| 98 - 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
|
99 |
| 384 | 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 | |
|
136
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 | 105 |
| 384 | 106 A big thanks also to all the maintainers of SàT packages |
| 107 | |
| 108 | |
| 109 ** CONTACT ** | |
| 110 | |
| 111 You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually: | |
| 60 | 112 |
| 384 | 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 | |
| 60 | 124 - wiki (wiki.goffi.org), in french & english so far |
| 125 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects) | |
| 126 - bugtracker (bugs.goffi.org) to report any problem or give suggestions | |
| 384 | 127 - mailing lists (lists.goffi.org) |
| 128 | |
| 129 and the official SàT website is at http://www.salut-a-toi.org | |
| 60 | 130 |
| 131 | |
| 132 | |
| 133 This software is dedicated to Roger Poisson. |