changeset 1520:88f99488e604

doc: update README to be more concise, and just talk about the frontend
author Goffi <goffi@goffi.org>
date Wed, 07 Jun 2023 09:17:05 +0200
parents 01b8d68edd70
children 0d517b596568
files README README.md
diffstat 2 files changed, 50 insertions(+), 168 deletions(-) [+]
line wrap: on
line diff
--- a/README	Tue Jun 06 17:40:16 2023 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,168 +0,0 @@
-Libervia (Salut à Toi)
-(c) Jérôme Poisson aka Goffi 2008-2021
-(c) Adrien Cossa aka Souliane 2013-2016
-
-Libervia is a frontend for Salut à Toi (SàT)
-SàT is a XMPP (Jabber) client.
-
-** LICENCE **
-
-Libervia is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-Libervia is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with Libervia.  If not, see <http://www.gnu.org/licenses/>.
-
-
-** ABOUT **
-
-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)
-
-** How to use it ? **
-
-Refer to the wiki for installation/use instructions: 
-http://wiki.goffi.org/wiki/Libervia
-
-refer to SàT README for more informations
-
-** CREDIT **
-
-A big big thank to the authors/contributors of...
-
-proxy65:
-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).
-As the original MIT licence allows, the code is reused and sub-licenced until GPL v3 to follow the rest of the code.
-
-progressbar:
-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.
-
-twisted:
-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 :).
-
-wokkel:
-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.
-
-Urwid:
-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.
-
-Pyjamas:
-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.
-
-lxml(http://lxml.de/):
-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.
-
-pillow(https://python-pillow.github.io/):
-This image manipulation module is used for avatars
-
-txJSON-RPC:
-Libervia use txJSON-RPC (https://launchpad.net/txjsonrpc), a twisted library to communicate with the browser's javascript throught JSON-RPC
-
-Mutagen:
-Mutagen (https://bitbucket.org/lazka/mutagen) is an audio metadata handling library, it's used by the radiocol plugin.
-
-Python OTR (http://python-otr.pentabarf.de), PyCrypto (https://www.dlitz.net/software/pycrypto) and pyOpenSSL(https://github.com/pyca/pyopenssl):
-Used for cryptography
-
-otr.js and its dependencies Big Integer Library, CryptoJS, EventEmitter:
-Libervia frontend uses otr.js and its dependencies:
-    - otr.js was coded by Arlo Breault (2014) and is released under the Mozilla Public License Version 2.0
-    - Big Integer Library was coded by Leemon Baird (2000-2013) and is in the public domain
-    - CryptoJS was coded by Jeff Mott (2009-2013) and is released under the MIT licence
-    - EventEmitter was coded by Oliver Caldwell (2011-2013) and is released under the MIT licence
-As the original licences allow, the code is reused and sub-licenced until GPL v3 to follow the rest of the code.
-
-mardown (https://pythonhosted.org/Markdown/) and html2text (https://pypi.python.org/pypi/html2text/2015.6.21):
-both are used for syntaxes conversions
-
-Jinja2 (http://jinja.pocoo.org/):
-a poweful template engine for Python that we use for designing Libervia's static blog pages
-
-miniupnp (http://miniupnp.free.fr/):
-this UPnP-IGD implementation is used to facilitate P2P sessions
-
-netifaces (https://pypi.python.org/pypi/netifaces):
-when available, this module is used to detect local IPs
-
-pictures found in the sat_media repository and used by SàT and Libervia:
-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
-
-the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
-
-PyXDF (http://freedesktop.org/wiki/Software/pyxdg):
-Used to follow FreeDesktop XDG standards
-
-A special thank to people working on XMPP standards, libre standards are the way to go !
-
-and the others:
-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.
-
-If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
-
-
-** CONTRIBUTORS **
-
-Salut à Toi has received contributions from:
-
-- 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.
-
-- Xavier Maillard <xavier@maillard.im>: bugs fixes. He's following the project for a while, maybe a future frontend contributor?
-
-- 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.
-
-- Matthieu Rakotojaona <matthieu.rakotojaona@gmail.com>: English translation of the social contract. A great quality translation!
-
-- Thomas Preud'homme <robotux@debian.org>: bugs fixes. He's also one of the co-maintainer of the Debian package.
-
-- Dal <kedals0@gmail.com>: profiles management, argparse refactoring in jp.
-
-- Matteo Cypriani <mcy@lm7.fr>: jp's mainloop update + doc improvements + various fixes. He's also the other co-maintainer of the Debian package.
-
-- Olly Betts <olly@survex.com>: icon fix in Wix [N.B: Wix has been removed]
-
-Many thanks to them.
-
-A big thanks also to all the maintainers of SàT packages.
-
-
-** CONTRIBUTIONS **
-
-Here are the URIs you can use to publish/retrieve tickets or merge requests:
-
-tickets: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.tickets%3A0 (please use "libervia" label)
-merge requests: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.merge_requests%3A0 (please use "libervia" label)
-
-Tickets and merge requests are handled by SàT itself using XMPP.
-
-
-** CONTACT **
-
-You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually:
-
-Goffi:
-	- goffi@goffi.org (e-mail)
-	- goffi@jabber.fr (jid)
-	- http://www.goffi.org (blog, with fresh news about SàT)
-
-Souliane:
-	- souliane@mailoo.org (e-mail)
-	- souliane@libervia.org (jid)
-
-You'll find the latest version and other stuffs on *.goffi.org websites:
-
-- wiki (wiki.goffi.org), in French & English so far
-- ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
-- bugtracker (bugs.goffi.org) to report any problem or give suggestions
-- mailing lists (lists.goffi.org)
-
-and the official SàT website is at http://www.salut-a-toi.org
-
-
-
-This software is dedicated to Roger Poisson.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Wed Jun 07 09:17:05 2023 +0200
@@ -0,0 +1,50 @@
+# Libervia Web
+
+### Copyrights
+
+- Jérôme Poisson aka Goffi 2008-2023
+- Adrien Cossa aka Souliane 2013-2016
+- Additional contributions by community members
+
+## License
+
+Libervia is a Libre software (Free as in "Freedom"), distributed under the AGPL v3+
+license. For the full license, please refer to the `COPYING` file.
+
+## Relevant URLs
+
+Here are some useful URLs, all of which (except for the source code repository) are
+powered by Libervia itself, showcasing the flexibility and versatility of the tool:
+
+- Official Website: <https://libervia.org>
+- Documentation: <https://libervia.org/documentation/web>
+- Bug Tracker: <https://libervia.org/tickets>
+- Source Code: <https://repos.goffi.org/libervia-web/>
+- News: <https://libervia.org/news> (currently the same as the blog below)
+- Main Developer's Blog: <https://www.goffi.org/>
+
+Additionally, our blogs are accessible via ActivityPub thanks to the Libervia XMPP <=>
+ActivityPub gateway.
+
+## About
+
+Libervia Web is the official web frontend of the Libervia project. It is designed to be
+user-friendly and offers a wide range of features including instant messaging, blogs,
+forums, photo albums, file sharing, event organization, personal agendas, and various
+kinds of lists (tickets, TODOs, shopping, etc.). Upcoming enhancements include the
+addition of video calls. Libervia Web is an all-encompassing, universally compatible tool,
+ideal for individuals, small and large groups, associations, internal communication,
+public-facing websites, and private social networks.
+
+The platform includes an easy-to-use invitation system, which simplifies the process of
+bringing new members into the network. This system allows people to participate even if
+they don't have an account.
+
+Leveraging the power of [Brython](https://www.brython.info/), Python can be utilized both
+server-side and in the browser. In essence, Libervia Web is a web framework created with
+Python, capitalizing on the robustness of XMPP and Libervia for data management. This
+makes it highly customizable, enabling the frontend to be easily adapted for specific use
+cases or themes.
+
+For additional information, please visit the [Official Website](https://libervia.org) or
+the [Libervia Backend Repository](https://repos.goffi.org/libervia-backend).