libervia-backend: README annotate

annotate README @ 4001:32d714a8ea51

plugin XEP-0045: dot not wait for MAM retrieval to be completed: in `_join_MAM`, `room.fully_joined` is called before retrieving the MAM archive, as the process can be very long, and is not necessary to have the room working (message can be received after being in the room, and added out of order). This avoid blocking the `join` workflow for an extended time. Some renaming and coroutine integrations.

author	Goffi <goffi@goffi.org>
date	Fri, 10 Mar 2023 17:22:41 +0100
parents	be6d91572633
children

rev	line source
2629 346887f256f0 doc (README): removed version from README to avoid having to update it each time + removed mentions to future frontends Goffi <goffi@goffi.org> parents: 2606 diff changeset	1 Salut à Toi
3479 be6d91572633 date update Goffi <goffi@goffi.org> parents: 3136 diff changeset	2 (c) Jérôme Poisson aka Goffi 2008-2021
1766 d17772b0fe22 copyright update Goffi <goffi@goffi.org> parents: 1718 diff changeset	3 (c) Adrien Cossa aka Souliane 2013-2016
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	4
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	5 SàT is a XMPP (Jabber) client.
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	6
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	7
874 1f5ad976fa32 some typos fixes in the README files souliane <souliane@mailoo.org> parents: 871 diff changeset	8 LICENCE
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	9
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	10 SàT is free software: you can redistribute it and/or modify
480 2a072735e459 Licence modification: the full project is now under AGPL v3+ instead of GPL v3+ Goffi <goffi@goffi.org> parents: 459 diff changeset	11 it under the terms of the GNU Affero General Public License as published by
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	12 the Free Software Foundation, either version 3 of the License, or
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	13 (at your option) any later version.
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	14
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	15 SàT is distributed in the hope that it will be useful,
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	16 but WITHOUT ANY WARRANTY; without even the implied warranty of
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
480 2a072735e459 Licence modification: the full project is now under AGPL v3+ instead of GPL v3+ Goffi <goffi@goffi.org> parents: 459 diff changeset	18 GNU Affero General Public License for more details.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	19
480 2a072735e459 Licence modification: the full project is now under AGPL v3+ instead of GPL v3+ Goffi <goffi@goffi.org> parents: 459 diff changeset	20 You should have received a copy of the GNU Affero General Public License
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	21 along with SàT. If not, see <http://www.gnu.org/licenses/>.
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	22
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	23
871 5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	24 ABOUT
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	25
871 5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	26 SàT is a XMPP (Jabber) client, made on a daemon/frontends architecture. Its aim is not only to be an instant messaging client: SàT manage microblogging, file transfer, rich text edition, piping over XMPP, XMPP remote, etc.
874 1f5ad976fa32 some typos fixes in the README files souliane <souliane@mailoo.org> parents: 871 diff changeset	27 In addition, SàT has been built with ethic in mind, a social contract show the main lines (see CONTRAT_SOCIAL or CONTRAT_SOCIAL_en). We have a lot of debates about the right way to do things, more on a social way than on a technical way (but consider technique too).
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	28
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	29 For the moment, the frontends are:
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	30
2104 4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	31 * primitivus: a console interface client, for terminal lovers
871 5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	32 * jp: the powerful command line toolkit.
2104 4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	33 * libervia: the web frontend. It's in a different package, check libervia on the wiki: https://wiki.goffi.org/wiki/Libervia
4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	34 * cagou: the desktop/mobile frontend. It's in a different package
4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	35 * bellaciao: a Qt frontend at an early development stage (development currently paused)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	36
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	37
871 5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	38 HOW TO USE IT ?
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	39
871 5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	40 For installation instructions, please read the file "INSTALL". Note that SàT is available in several GNU/Linux distributions
238 83d2bc0abf2a version, README, CHANGELOG and INSTALL updates Goffi <goffi@goffi.org> parents: 228 diff changeset	41
2104 4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	42 A wiki is available online (https://wiki.goffi.org), in French and English so far (we would appreciate any help for other languages). You can also have a look at the bottom of this files (in contact section) for other available websites.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	43
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	44
871 5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	45 MISC
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	46
626 190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	47 To use SàT, you need to have D-Bus daemon launched (http://www.freedesktop.org/wiki/Software/dbus/). If you use X Window, it should already be launched. If your are on a terminal environment without X11 (e.g. on a server) you may have to launch it. You can launch a daemon using the following command:
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	48 $ eval `dbus-launch --sh-syntax`
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	49
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	50 Be careful to use the same environment variables if you start a new session.
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	51
874 1f5ad976fa32 some typos fixes in the README files souliane <souliane@mailoo.org> parents: 871 diff changeset	52 I personally use the following script to do that automatically:
626 190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	53
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	54 --- /usr/local/bin/dbus-launch.sh ---
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	55 #!/bin/sh
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	56
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	57 DBUS_PATH="/tmp/.dbus.`whoami`"
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	58
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	59 if [ ! -e $DBUS_PATH ]; then
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	60 dbus-launch --sh-syntax > $DBUS_PATH
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	61 chmod 400 $DBUS_PATH
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	62 fi
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	63
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	64 cat $DBUS_PATH
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	65 --- end of /usr/local/bin/dbus-launch.sh ---
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	66
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	67 You can launch this script by putting at the end of your .zshrc (or whatever you're using):
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	68 eval `/usr/local/bin/dbus-launch.sh`
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	69
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	70 --
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27. Goffi <goffi@goffi.org> parents: 614 diff changeset	71
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 581 diff changeset	72 You can find Primitivus shortcuts on the wiki:
2104 4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	73 https://wiki.goffi.org/wiki/Primitivus
348 8ff113e2abcb updated README and CHANGELOG Goffi <goffi@goffi.org> parents: 322 diff changeset	74
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	75 --
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	76
2104 4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	77 SàT is the acronym (yes another one :( ) in tribute to the song Salut à Toi from the Bérurier Noir band and it means "hi to you" (which seems appropriate for a communication software). If you want to listen to the song, we also recommend the excellent cover from Les Ogres de Barback.
4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	78 jp stands for "Jabber coPy" or "JumP", and was choosen for its similarity with "cp" and short name.
1201 62135e3ca7ff misc: README typos fixes Matteo Cypriani <mcy@lm7.fr> parents: 1192 diff changeset	79 Primitivus is based on Urwid, and, according to their FAQ, "ur" is a German prefix for "ancestral or primal" (primitivus is a latin word).
2104 4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	80 Libervia is made from "Liber" (libre) and via (road, path). It could be understood as the libre road, or the path to freedom.
4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	81 Cagou is the name of a beautiful bird (who bark and can't fly) from New-Caledonia, and it's also a wink to Kivy, the framework used.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	82
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	83
871 5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	84 CREDIT
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	85
181 a566f654929e README update: Goffi <goffi@goffi.org> parents: 57 diff changeset	86 A big big thank to the authors/contributors of...
a566f654929e README update: Goffi <goffi@goffi.org> parents: 57 diff changeset	87
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	88 proxy65:
874 1f5ad976fa32 some typos fixes in the README files souliane <souliane@mailoo.org> parents: 871 diff changeset	89 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).
1157 c4b62e6b7377 add licence information for otr.js and dependencies souliane <souliane@mailoo.org> parents: 900 diff changeset	90 As the original MIT licence allows, the code is reused and sub-licenced until GPL v3 to follow the rest of the code.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	91
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	92 progressbar:
181 a566f654929e README update: Goffi <goffi@goffi.org> parents: 57 diff changeset	93 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.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	94
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	95 twisted:
348 8ff113e2abcb updated README and CHANGELOG Goffi <goffi@goffi.org> parents: 322 diff changeset	96 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 :).
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	97
24 61124cb82fb7 Updated README and licenses (for images), added installation instructions. Goffi <goffi@goffi.org> parents: 0 diff changeset	98 wokkel:
61124cb82fb7 Updated README and licenses (for images), added installation instructions. Goffi <goffi@goffi.org> parents: 0 diff changeset	99 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.
61124cb82fb7 Updated README and licenses (for images), added installation instructions. Goffi <goffi@goffi.org> parents: 0 diff changeset	100
181 a566f654929e README update: Goffi <goffi@goffi.org> parents: 57 diff changeset	101 Urwid:
a566f654929e README update: Goffi <goffi@goffi.org> parents: 57 diff changeset	102 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.
24 61124cb82fb7 Updated README and licenses (for images), added installation instructions. Goffi <goffi@goffi.org> parents: 0 diff changeset	103
348 8ff113e2abcb updated README and CHANGELOG Goffi <goffi@goffi.org> parents: 322 diff changeset	104 Pyjamas:
874 1f5ad976fa32 some typos fixes in the README files souliane <souliane@mailoo.org> parents: 871 diff changeset	105 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.
348 8ff113e2abcb updated README and CHANGELOG Goffi <goffi@goffi.org> parents: 322 diff changeset	106
2104 4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	107 Kivy and its linked tools (python-for-android, buildozer, plyer, pyjnius):
4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	108 Kivy and linked tools (https://kivy.org) are used to build Cagou frontend, and to port it on several platforms. Excellent pieces of software, well thought,
4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	109
4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	110 Kivy garden:
4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	111 in addition to Kivy itself, extension from the garden are used:
4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	112 - contextmenu: used to display main and context menus
4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	113
1541 685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	114 lxml(http://lxml.de/):
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	115 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.
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	116
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	117 pillow(https://python-pillow.github.io/):
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	118 This image manipulation module is used for avatars
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	119
348 8ff113e2abcb updated README and CHANGELOG Goffi <goffi@goffi.org> parents: 322 diff changeset	120 txJSON-RPC:
8ff113e2abcb updated README and CHANGELOG Goffi <goffi@goffi.org> parents: 322 diff changeset	121 Libervia use txJSON-RPC (https://launchpad.net/txjsonrpc), a twisted library to communicate with the browser's javascript throught JSON-RPC
8ff113e2abcb updated README and CHANGELOG Goffi <goffi@goffi.org> parents: 322 diff changeset	122
578 28331ecf0a65 misc: README cleaning + added Mutagen to credits Goffi <goffi@goffi.org> parents: 576 diff changeset	123 Mutagen:
1541 685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	124 Mutagen (https://bitbucket.org/lazka/mutagen) is an audio metadata handling library, it's used by the radiocol plugin.
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	125
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	126 Python OTR (http://python-otr.pentabarf.de), PyCrypto (https://www.dlitz.net/software/pycrypto) and pyOpenSSL(https://github.com/pyca/pyopenssl):
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	127 Used for cryptography
578 28331ecf0a65 misc: README cleaning + added Mutagen to credits Goffi <goffi@goffi.org> parents: 576 diff changeset	128
1157 c4b62e6b7377 add licence information for otr.js and dependencies souliane <souliane@mailoo.org> parents: 900 diff changeset	129 otr.js and its dependencies Big Integer Library, CryptoJS, EventEmitter:
c4b62e6b7377 add licence information for otr.js and dependencies souliane <souliane@mailoo.org> parents: 900 diff changeset	130 Libervia frontend uses otr.js and its dependencies:
c4b62e6b7377 add licence information for otr.js and dependencies souliane <souliane@mailoo.org> parents: 900 diff changeset	131 - otr.js was coded by Arlo Breault (2014) and is released under the Mozilla Public License Version 2.0
c4b62e6b7377 add licence information for otr.js and dependencies souliane <souliane@mailoo.org> parents: 900 diff changeset	132 - Big Integer Library was coded by Leemon Baird (2000-2013) and is in the public domain
c4b62e6b7377 add licence information for otr.js and dependencies souliane <souliane@mailoo.org> parents: 900 diff changeset	133 - CryptoJS was coded by Jeff Mott (2009-2013) and is released under the MIT licence
c4b62e6b7377 add licence information for otr.js and dependencies souliane <souliane@mailoo.org> parents: 900 diff changeset	134 - EventEmitter was coded by Oliver Caldwell (2011-2013) and is released under the MIT licence
c4b62e6b7377 add licence information for otr.js and dependencies souliane <souliane@mailoo.org> parents: 900 diff changeset	135 As the original licences allow, the code is reused and sub-licenced until GPL v3 to follow the rest of the code.
c4b62e6b7377 add licence information for otr.js and dependencies souliane <souliane@mailoo.org> parents: 900 diff changeset	136
1541 685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	137 mardown (https://pythonhosted.org/Markdown/) and html2text (https://pypi.python.org/pypi/html2text/2015.6.21):
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	138 both are used for syntaxes conversions
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	139
1717 77a010f1f8cb README and README4PACKAGERS: add Jinja2 to the dependencies list souliane <souliane@mailoo.org> parents: 1561 diff changeset	140 Jinja2 (http://jinja.pocoo.org/):
77a010f1f8cb README and README4PACKAGERS: add Jinja2 to the dependencies list souliane <souliane@mailoo.org> parents: 1561 diff changeset	141 a poweful template engine for Python that we use for designing Libervia's static blog pages
77a010f1f8cb README and README4PACKAGERS: add Jinja2 to the dependencies list souliane <souliane@mailoo.org> parents: 1561 diff changeset	142
1541 685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	143 miniupnp (http://miniupnp.free.fr/):
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	144 this UPnP-IGD implementation is used to facilitate P2P sessions
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	145
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	146 netifaces (https://pypi.python.org/pypi/netifaces):
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	147 when available, this module is used to detect local IPs
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	148
1176 bc3cdf770328 README: redirect media credits to sat_media repository (the pictures are no more hosted here) souliane <souliane@mailoo.org> parents: 1157 diff changeset	149 pictures found in the sat_media repository and used by SàT and Libervia:
bc3cdf770328 README: redirect media credits to sat_media repository (the pictures are no more hosted here) souliane <souliane@mailoo.org> parents: 1157 diff changeset	150 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
181 a566f654929e README update: Goffi <goffi@goffi.org> parents: 57 diff changeset	151
a566f654929e README update: Goffi <goffi@goffi.org> parents: 57 diff changeset	152 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
a566f654929e README update: Goffi <goffi@goffi.org> parents: 57 diff changeset	153
1541 685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	154 PyXDF (http://freedesktop.org/wiki/Software/pyxdg):
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	155 Used to follow FreeDesktop XDG standards
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	156
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	157 A special thank to people working on XMPP standards, libre standards are the way to go !
685fad1c18e4 README, README4PACKAGERS: some update about third party modules. Goffi <goffi@goffi.org> parents: 1396 diff changeset	158
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	159 and the others:
2104 4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	160 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 we 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 this.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	161
2104 4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	162 If we forgot any credit (and we probably have), please contact us (mail below) to fix it.
24 61124cb82fb7 Updated README and licenses (for images), added installation instructions. Goffi <goffi@goffi.org> parents: 0 diff changeset	163
871 5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	164
5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	165 CONTRIBUTORS
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	166
482 e0d1eed4a46b misc: updated README with contributors Goffi <goffi@goffi.org> parents: 480 diff changeset	167 Salut à Toi has received contributions from:
e0d1eed4a46b misc: updated README with contributors Goffi <goffi@goffi.org> parents: 480 diff changeset	168
2606 6a261b725f71 misc (README): added sat_templates installation for Xavier Maillard contributions + removed non contributions related sentences: Goffi <goffi@goffi.org> parents: 2570 diff changeset	169 - Adrien Vigneron <adrienvigneron@mailoo.org>: huge work on Libervia's CSS, SàT Logo (the mascot is his work), and Quiz game graphics.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	170
2606 6a261b725f71 misc (README): added sat_templates installation for Xavier Maillard contributions + removed non contributions related sentences: Goffi <goffi@goffi.org> parents: 2570 diff changeset	171 - Xavier Maillard <xavier@maillard.im>: bugs fixes, sat_templates installation.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	172
2606 6a261b725f71 misc (README): added sat_templates installation for Xavier Maillard contributions + removed non contributions related sentences: Goffi <goffi@goffi.org> parents: 2570 diff changeset	173 - Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>: bugs fixes, Libervia's notification, Libervia as a twisted application plugin.
482 e0d1eed4a46b misc: updated README with contributors Goffi <goffi@goffi.org> parents: 480 diff changeset	174
2606 6a261b725f71 misc (README): added sat_templates installation for Xavier Maillard contributions + removed non contributions related sentences: Goffi <goffi@goffi.org> parents: 2570 diff changeset	175 - Matthieu Rakotojaona <matthieu.rakotojaona@gmail.com>: English translation of the social contract.
482 e0d1eed4a46b misc: updated README with contributors Goffi <goffi@goffi.org> parents: 480 diff changeset	176
1201 62135e3ca7ff misc: README typos fixes Matteo Cypriani <mcy@lm7.fr> parents: 1192 diff changeset	177 - Thomas Preud'homme <robotux@debian.org>: bugs fixes. He's also one of the co-maintainer of the Debian package.
614 bef0f893482f misc: added Thomas Preud'homme to contributors + a thanks message to maintainers =) Goffi <goffi@goffi.org> parents: 587 diff changeset	178
1201 62135e3ca7ff misc: README typos fixes Matteo Cypriani <mcy@lm7.fr> parents: 1192 diff changeset	179 - Dal <kedals0@gmail.com>: profiles management, argparse refactoring in jp.
658 e26134122ed7 misc: added Dal to contributors Goffi <goffi@goffi.org> parents: 640 diff changeset	180
1204 2ee0cd57144e misc: added Olly Betts to contributors + various fixed for Matteo Cypriani Goffi <goffi@goffi.org> parents: 1203 diff changeset	181 - Matteo Cypriani <mcy@lm7.fr>: jp's mainloop update + doc improvements + various fixes. He's also the other co-maintainer of the Debian package.
2ee0cd57144e misc: added Olly Betts to contributors + various fixed for Matteo Cypriani Goffi <goffi@goffi.org> parents: 1203 diff changeset	182
2806 2400cad2dace misc (README): typo Goffi <goffi@goffi.org> parents: 2771 diff changeset	183 - Olly Betts <olly@survex.com>: icon fix in Wix [N.B.: Wix has since been removed]
2006 0ddf3edf643a added Chteufleur in contributors in README Goffi <goffi@goffi.org> parents: 1997 diff changeset	184
2025 43516c915ca6 misc: updated Chteufleur contributions in README Goffi <goffi@goffi.org> parents: 2006 diff changeset	185 - Geoffrey Pouzet <chteufleur@kingpenguin.tk>: XEP-0070 and XEP-0184 implementations
900 21681070f913 misc: added Naha to README Goffi <goffi@goffi.org> parents: 887 diff changeset	186
2569 a44b62e458be README: added Arnaud Joset to contributors Goffi <goffi@goffi.org> parents: 2557 diff changeset	187 - Arnaud Joset <info@agayon.be>: setup fixes
a44b62e458be README: added Arnaud Joset to contributors Goffi <goffi@goffi.org> parents: 2557 diff changeset	188
482 e0d1eed4a46b misc: updated README with contributors Goffi <goffi@goffi.org> parents: 480 diff changeset	189 Many thanks to them.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	190
2570 2ac37dfc408b README: typo Goffi <goffi@goffi.org> parents: 2569 diff changeset	191 A big thank also to all the maintainers of SàT packages.
614 bef0f893482f misc: added Thomas Preud'homme to contributors + a thanks message to maintainers =) Goffi <goffi@goffi.org> parents: 587 diff changeset	192
871 5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	193
2549 f685ad80ee98 README: specified URIs location for tickets and merge requests Goffi <goffi@goffi.org> parents: 2483 diff changeset	194 CONTRIBUTIONS
f685ad80ee98 README: specified URIs location for tickets and merge requests Goffi <goffi@goffi.org> parents: 2483 diff changeset	195
f685ad80ee98 README: specified URIs location for tickets and merge requests Goffi <goffi@goffi.org> parents: 2483 diff changeset	196 Here are the URIs you can use to publish/retrieve tickets or merge requests:
f685ad80ee98 README: specified URIs location for tickets and merge requests Goffi <goffi@goffi.org> parents: 2483 diff changeset	197
2555 ebdaaf858f21 README: label to use for tickets and merge requests is specified Goffi <goffi@goffi.org> parents: 2549 diff changeset	198 tickets: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.tickets%3A0 (please use "core" label)
ebdaaf858f21 README: label to use for tickets and merge requests is specified Goffi <goffi@goffi.org> parents: 2549 diff changeset	199 merge requests: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.merge_requests%3A0 (please use "core" label)
2549 f685ad80ee98 README: specified URIs location for tickets and merge requests Goffi <goffi@goffi.org> parents: 2483 diff changeset	200
f685ad80ee98 README: specified URIs location for tickets and merge requests Goffi <goffi@goffi.org> parents: 2483 diff changeset	201 Tickets and merge requests are handled by SàT itself using XMPP.
f685ad80ee98 README: specified URIs location for tickets and merge requests Goffi <goffi@goffi.org> parents: 2483 diff changeset	202
2557 f2a829bbdbb5 README: minor line addition Goffi <goffi@goffi.org> parents: 2555 diff changeset	203
871 5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	204 CONTACT
5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	205
5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	206 You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually:
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	207
2104 4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	208 SàT team:
4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	209 - contact@salut-a-toi.invalid (replace invalid by org)
4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	210 - https://libervia.org/blog/salut-a-toi (blog)
4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	211
871 5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	212 Goffi:
5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	213 - goffi@goffi.org (e-mail)
5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	214 - goffi@jabber.fr (jid)
2104 4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	215 - https://www.goffi.org (blog - based on Libervia -, with fresh news about SàT)
871 5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	216
5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	217 Souliane:
5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	218 - souliane@mailoo.org (e-mail)
5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	219 - souliane@libervia.org (jid)
5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	220
5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	221 You'll find the latest version and other stuffs on *.goffi.org websites:
5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	222
1201 62135e3ca7ff misc: README typos fixes Matteo Cypriani <mcy@lm7.fr> parents: 1192 diff changeset	223 - wiki (wiki.goffi.org), in French & English so far
238 83d2bc0abf2a version, README, CHANGELOG and INSTALL updates Goffi <goffi@goffi.org> parents: 228 diff changeset	224 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates Goffi <goffi@goffi.org> parents: 228 diff changeset	225 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
871 5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	226 - mailing lists (lists.goffi.org)
5d08ab99e8dd README and INSTALL updates Goffi <goffi@goffi.org> parents: 816 diff changeset	227
2104 4f189bd1d9ed misc: README update Goffi <goffi@goffi.org> parents: 2025 diff changeset	228 and the official SàT website is at https://www.salut-a-toi.org
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	229
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	230
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	231 This software is dedicated to Roger Poisson.

Mercurial > libervia-backend

annotate README @ 4001:32d714a8ea51