Mercurial > libervia-web
annotate README @ 1301:ff44f822bfdd
browser (photos): albums can now be deleted:
when albums are deleted, there are removed from list of interest, and all photos inside
are also deleted.
Doesn't check permissions before deletion yet, so the button is always present even when it
may fail.
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 19 Jun 2020 16:47:51 +0200 |
| parents | 987595a254b0 |
| children | 822bd0139769 |
| rev | line source |
|---|---|
|
1114
1957d02df281
doc (README): removed version from README
Goffi <goffi@goffi.org>
parents:
1084
diff
changeset
|
1 Libervia (Salut à Toi) |
| 1237 | 2 (c) Jérôme Poisson aka Goffi 2008-2020 |
| 818 | 3 (c) Adrien Cossa aka Souliane 2013-2016 |
| 60 | 4 |
|
1114
1957d02df281
doc (README): removed version from README
Goffi <goffi@goffi.org>
parents:
1084
diff
changeset
|
5 Libervia is a frontend for Salut à Toi (SàT) |
| 60 | 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 |
| 384 | 35 ** CREDIT ** |
| 60 | 36 |
| 37 A big big thank to the authors/contributors of... | |
| 38 | |
| 39 proxy65: | |
| 384 | 40 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). |
| 790 | 41 As the original MIT licence allows, the code is reused and sub-licenced until GPL v3 to follow the rest of the code. |
| 60 | 42 |
| 43 progressbar: | |
| 44 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. | |
| 45 | |
| 46 twisted: | |
| 47 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 :). | |
| 48 | |
| 49 wokkel: | |
| 50 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. | |
| 51 | |
| 52 Urwid: | |
| 53 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. | |
| 54 | |
| 55 Pyjamas: | |
| 384 | 56 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 | 57 |
| 790 | 58 lxml(http://lxml.de/): |
| 59 this powerful and efficient XML parsing module is used sometimes to replace Twisted internal tools: its API is handy, and it have some features like evil content cleaning. | |
| 60 | |
| 61 pillow(https://python-pillow.github.io/): | |
| 62 This image manipulation module is used for avatars | |
| 60 | 63 |
| 64 txJSON-RPC: | |
| 790 | 65 Libervia use txJSON-RPC (https://launchpad.net/txjsonrpc), a twisted library to communicate with the browser's javascript throught JSON-RPC |
| 60 | 66 |
|
168
eb2f7b1560c2
misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents:
166
diff
changeset
|
67 Mutagen: |
| 790 | 68 Mutagen (https://bitbucket.org/lazka/mutagen) is an audio metadata handling library, it's used by the radiocol plugin. |
| 69 | |
| 70 Python OTR (http://python-otr.pentabarf.de), PyCrypto (https://www.dlitz.net/software/pycrypto) and pyOpenSSL(https://github.com/pyca/pyopenssl): | |
| 71 Used for cryptography | |
|
168
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 |
| 790 | 79 As the original licences allow, the code is reused and sub-licenced until GPL v3 to follow the rest of the code. |
| 80 | |
| 81 mardown (https://pythonhosted.org/Markdown/) and html2text (https://pypi.python.org/pypi/html2text/2015.6.21): | |
| 82 both are used for syntaxes conversions | |
|
714
03e9fe91081c
browser_side: use favico.js to display alerts counter
souliane <souliane@mailoo.org>
parents:
685
diff
changeset
|
83 |
| 790 | 84 Jinja2 (http://jinja.pocoo.org/): |
| 85 a poweful template engine for Python that we use for designing Libervia's static blog pages | |
| 86 | |
| 87 miniupnp (http://miniupnp.free.fr/): | |
| 88 this UPnP-IGD implementation is used to facilitate P2P sessions | |
| 89 | |
| 90 netifaces (https://pypi.python.org/pypi/netifaces): | |
| 91 when available, this module is used to detect local IPs | |
|
526
ee38b6a87692
add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents:
385
diff
changeset
|
92 |
|
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
|
93 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
|
94 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 | 95 |
| 96 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture. | |
| 97 | |
| 790 | 98 PyXDF (http://freedesktop.org/wiki/Software/pyxdg): |
| 99 Used to follow FreeDesktop XDG standards | |
| 100 | |
| 101 A special thank to people working on XMPP standards, libre standards are the way to go ! | |
| 102 | |
| 60 | 103 and the others: |
| 384 | 104 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 | 105 |
| 106 If I forgot any credit (and I probably have), please contact me (mail below) to fix it. | |
| 107 | |
| 384 | 108 |
| 109 ** CONTRIBUTORS ** | |
| 60 | 110 |
|
136
9d7d98954e34
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
131
diff
changeset
|
111 Salut à Toi has received contributions from: |
|
9d7d98954e34
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
131
diff
changeset
|
112 |
| 790 | 113 - Adrien Vigneron <adrienvigneron@mailoo.org>: huge work on Libervia's CSS, SàT Logo (the mascot is his work), and Quiz game graphics. He's friendly and talented, his work is really appreciated. |
| 60 | 114 |
| 790 | 115 - Xavier Maillard <xavier@maillard.im>: bugs fixes. He's following the project for a while, maybe a future frontend contributor? |
| 60 | 116 |
| 384 | 117 - 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. |
| 118 | |
| 790 | 119 - 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
|
120 |
| 790 | 121 - Thomas Preud'homme <robotux@debian.org>: bugs fixes. He's also one of the co-maintainer of the Debian package. |
| 384 | 122 |
| 790 | 123 - 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
|
124 |
| 790 | 125 - Matteo Cypriani <mcy@lm7.fr>: jp's mainloop update + doc improvements + various fixes. He's also the other co-maintainer of the Debian package. |
| 126 | |
| 127 - Olly Betts <olly@survex.com>: icon fix in Wix [N.B: Wix has been removed] | |
| 545 | 128 |
|
136
9d7d98954e34
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
131
diff
changeset
|
129 Many thanks to them. |
| 60 | 130 |
| 790 | 131 A big thanks also to all the maintainers of SàT packages. |
| 384 | 132 |
| 133 | |
|
1084
a24dd1d316f5
README: specified contribution URIs and label
Goffi <goffi@goffi.org>
parents:
903
diff
changeset
|
134 ** CONTRIBUTIONS ** |
|
a24dd1d316f5
README: specified contribution URIs and label
Goffi <goffi@goffi.org>
parents:
903
diff
changeset
|
135 |
|
a24dd1d316f5
README: specified contribution URIs and label
Goffi <goffi@goffi.org>
parents:
903
diff
changeset
|
136 Here are the URIs you can use to publish/retrieve tickets or merge requests: |
|
a24dd1d316f5
README: specified contribution URIs and label
Goffi <goffi@goffi.org>
parents:
903
diff
changeset
|
137 |
|
a24dd1d316f5
README: specified contribution URIs and label
Goffi <goffi@goffi.org>
parents:
903
diff
changeset
|
138 tickets: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.tickets%3A0 (please use "libervia" label) |
|
a24dd1d316f5
README: specified contribution URIs and label
Goffi <goffi@goffi.org>
parents:
903
diff
changeset
|
139 merge requests: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.merge_requests%3A0 (please use "libervia" label) |
|
a24dd1d316f5
README: specified contribution URIs and label
Goffi <goffi@goffi.org>
parents:
903
diff
changeset
|
140 |
|
a24dd1d316f5
README: specified contribution URIs and label
Goffi <goffi@goffi.org>
parents:
903
diff
changeset
|
141 Tickets and merge requests are handled by SàT itself using XMPP. |
|
a24dd1d316f5
README: specified contribution URIs and label
Goffi <goffi@goffi.org>
parents:
903
diff
changeset
|
142 |
|
a24dd1d316f5
README: specified contribution URIs and label
Goffi <goffi@goffi.org>
parents:
903
diff
changeset
|
143 |
| 384 | 144 ** CONTACT ** |
| 145 | |
| 146 You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually: | |
| 60 | 147 |
| 384 | 148 Goffi: |
| 149 - goffi@goffi.org (e-mail) | |
| 150 - goffi@jabber.fr (jid) | |
| 151 - http://www.goffi.org (blog, with fresh news about SàT) | |
| 152 | |
| 153 Souliane: | |
| 154 - souliane@mailoo.org (e-mail) | |
| 155 - souliane@libervia.org (jid) | |
| 156 | |
| 157 You'll find the latest version and other stuffs on *.goffi.org websites: | |
| 158 | |
| 903 | 159 - wiki (wiki.goffi.org), in French & English so far |
| 60 | 160 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects) |
| 161 - bugtracker (bugs.goffi.org) to report any problem or give suggestions | |
| 384 | 162 - mailing lists (lists.goffi.org) |
| 163 | |
| 164 and the official SàT website is at http://www.salut-a-toi.org | |
| 60 | 165 |
| 166 | |
| 167 | |
| 168 This software is dedicated to Roger Poisson. |