annotate README @ 1551:591c32dbfb0b

core (client): add IQ method to easily create an IQ stanza with the current xmlstream, and manage result with a Deferred.
author Goffi <goffi@goffi.org>
date Mon, 02 Nov 2015 22:02:41 +0100
parents 685fad1c18e4
children c09429bf587f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1208
008c8ccd5dcc version update
souliane <souliane@mailoo.org>
parents: 1204
diff changeset
1 SàT v0.5.1
1396
069ad98b360d 2015 copyright dates update
Goffi <goffi@goffi.org>
parents: 1291
diff changeset
2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
069ad98b360d 2015 copyright dates update
Goffi <goffi@goffi.org>
parents: 1291
diff changeset
3 (c) Adrien Cossa aka Souliane 2013, 2014, 2015
0
goffi@necton2
parents:
diff changeset
4
goffi@necton2
parents:
diff changeset
5 SàT is a XMPP (Jabber) client.
goffi@necton2
parents:
diff changeset
6
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
goffi@necton2
parents:
diff changeset
9
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
goffi@necton2
parents:
diff changeset
12 the Free Software Foundation, either version 3 of the License, or
goffi@necton2
parents:
diff changeset
13 (at your option) any later version.
goffi@necton2
parents:
diff changeset
14
goffi@necton2
parents:
diff changeset
15 SàT is distributed in the hope that it will be useful,
goffi@necton2
parents:
diff changeset
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
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
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
goffi@necton2
parents:
diff changeset
21 along with SàT. If not, see <http://www.gnu.org/licenses/>.
goffi@necton2
parents:
diff changeset
22
goffi@necton2
parents:
diff changeset
23
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
24 ** ABOUT **
0
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
goffi@necton2
parents:
diff changeset
28
goffi@necton2
parents:
diff changeset
29 For the moment, the frontends are:
goffi@necton2
parents:
diff changeset
30
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
31 * primitivus: a console interface client, for screen lovers
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
32 * jp: the powerful command line toolkit.
348
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
33 * libervia: the web frontend. It's in a different package, check libervia on the wiki: http://wiki.goffi.org/wiki/Libervia
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
34 * bellaciao: a Qt frontend at an early development stage
0
goffi@necton2
parents:
diff changeset
35
goffi@necton2
parents:
diff changeset
36 other frontends planed in the near future:
goffi@necton2
parents:
diff changeset
37
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
38 * mobile frontends, fuse frontend, etc.
0
goffi@necton2
parents:
diff changeset
39
goffi@necton2
parents:
diff changeset
40
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
41 ** HOW TO USE IT ? **
0
goffi@necton2
parents:
diff changeset
42
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
43 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
44
1201
62135e3ca7ff misc: README typos fixes
Matteo Cypriani <mcy@lm7.fr>
parents: 1192
diff changeset
45 A wiki is available online (http://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
goffi@necton2
parents:
diff changeset
46
goffi@necton2
parents:
diff changeset
47
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
48 ** MISC **
0
goffi@necton2
parents:
diff changeset
49
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
50 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
51 $ 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
52
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 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
54
874
1f5ad976fa32 some typos fixes in the README files
souliane <souliane@mailoo.org>
parents: 871
diff changeset
55 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
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 --- /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
58 #!/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
59
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_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
61
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 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
63 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
64 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
65 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
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 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
68 --- 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
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 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
71 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
72
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
73 --
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
74
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
75 You can find Primitivus shortcuts on the wiki:
348
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
76 http://wiki.goffi.org/wiki/Primitivus
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
77
0
goffi@necton2
parents:
diff changeset
78 --
goffi@necton2
parents:
diff changeset
79
874
1f5ad976fa32 some typos fixes in the README files
souliane <souliane@mailoo.org>
parents: 871
diff changeset
80 SàT is the acronym (yes another one :( ) in tribute to the song Salut à Toi from the Bérurier Noir band. I recommend also the excellent cover from Les Ogres de Barback.
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
81 jp stands for "Jabber coPy" or "JumP".
1201
62135e3ca7ff misc: README typos fixes
Matteo Cypriani <mcy@lm7.fr>
parents: 1192
diff changeset
82 Primitivus is based on Urwid, and, according to their FAQ, "ur" is a German prefix for "ancestral or primal" (primitivus is a latin word).
0
goffi@necton2
parents:
diff changeset
83
goffi@necton2
parents:
diff changeset
84
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
85 ** /!\ PRIVACY WARNING /!\ **
0
goffi@necton2
parents:
diff changeset
86
1201
62135e3ca7ff misc: README typos fixes
Matteo Cypriani <mcy@lm7.fr>
parents: 1192
diff changeset
87 To make setup easier, SàT asks a website (http://www.goffi.org) the external ip address of client. So a request is made to this page: http://www.goffi.org/sat_tools/get_ip.php .
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
88 The IP will appear in the private Apache logs (in the same way as IP used to download the software), which are automatically saved, but will not be used. Future releases will probably come with a warning about this and an easy way to avoid it.
0
goffi@necton2
parents:
diff changeset
89
goffi@necton2
parents:
diff changeset
90
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
91 ** CREDIT **
0
goffi@necton2
parents:
diff changeset
92
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
93 A big big thank to the authors/contributors of...
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
94
0
goffi@necton2
parents:
diff changeset
95 proxy65:
874
1f5ad976fa32 some typos fixes in the README files
souliane <souliane@mailoo.org>
parents: 871
diff changeset
96 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
97 As the original MIT licence allows, the code is reused and sub-licenced until GPL v3 to follow the rest of the code.
0
goffi@necton2
parents:
diff changeset
98
goffi@necton2
parents:
diff changeset
99 progressbar:
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
100 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
goffi@necton2
parents:
diff changeset
101
goffi@necton2
parents:
diff changeset
102 twisted:
348
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
103 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
goffi@necton2
parents:
diff changeset
104
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
105 wokkel:
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
106 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
107
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
108 Urwid:
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
109 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
110
348
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
111 Pyjamas:
874
1f5ad976fa32 some typos fixes in the README files
souliane <souliane@mailoo.org>
parents: 871
diff changeset
112 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
113
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
114 Pyfeed and Xe:
1203
6e08ee45bf0a misc: updated urls of pyxe an pyfeed
Matteo Cypriani <mcy@lm7.fr>
parents: 1201
diff changeset
115 SàT core and Libervia use pyfeed and xe (http://home.avvanta.com/%7Esteveha/pyfeed.html), 2 libraries made Steve R. Hastings really useful to parse/generate xml stuff as atom feeds.
348
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
116
1541
685fad1c18e4 README, README4PACKAGERS: some update about third party modules.
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
117 lxml(http://lxml.de/):
685fad1c18e4 README, README4PACKAGERS: some update about third party modules.
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
118 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
119
685fad1c18e4 README, README4PACKAGERS: some update about third party modules.
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
120 pillow(https://python-pillow.github.io/):
685fad1c18e4 README, README4PACKAGERS: some update about third party modules.
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
121 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
122
348
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
123 txJSON-RPC:
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
124 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
125
578
28331ecf0a65 misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents: 576
diff changeset
126 Mutagen:
1541
685fad1c18e4 README, README4PACKAGERS: some update about third party modules.
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
127 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
128
685fad1c18e4 README, README4PACKAGERS: some update about third party modules.
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
129 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
130 Used for cryptography
578
28331ecf0a65 misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents: 576
diff changeset
131
1157
c4b62e6b7377 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 900
diff changeset
132 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
133 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
134 - 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
135 - 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
136 - 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
137 - 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
138 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
139
1541
685fad1c18e4 README, README4PACKAGERS: some update about third party modules.
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
140 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
141 both are used for syntaxes conversions
685fad1c18e4 README, README4PACKAGERS: some update about third party modules.
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
142
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
goffi@necton2
parents:
diff changeset
159 and the others:
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
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 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.
0
goffi@necton2
parents:
diff changeset
161
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
162 If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
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
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
1201
62135e3ca7ff misc: README typos fixes
Matteo Cypriani <mcy@lm7.fr>
parents: 1192
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. He's friendly and talented, his work is really appreciated.
0
goffi@necton2
parents:
diff changeset
170
1201
62135e3ca7ff misc: README typos fixes
Matteo Cypriani <mcy@lm7.fr>
parents: 1192
diff changeset
171 - Xavier Maillard <xavier@maillard.im>: bugs fixes. He's following the project for a while, maybe a future frontend contributor?
0
goffi@necton2
parents:
diff changeset
172
816
4429bd7d5efb misc (README): updated Link Mauve and Dal contributions, moved Souliane as a main contributor
Goffi <goffi@goffi.org>
parents: 811
diff changeset
173 - 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.
482
e0d1eed4a46b misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 480
diff changeset
174
1201
62135e3ca7ff misc: README typos fixes
Matteo Cypriani <mcy@lm7.fr>
parents: 1192
diff changeset
175 - Matthieu Rakotojaona <matthieu.rakotojaona@gmail.com>: English translation of the social contract. A great quality translation!
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
1291
0db0013c59dd remove remaining references to Wix
souliane <souliane@mailoo.org>
parents: 1208
diff changeset
183 - Olly Betts <olly@survex.com>: icon fix in Wix [N.B: Wix has been removed]
900
21681070f913 misc: added Naha to README
Goffi <goffi@goffi.org>
parents: 887
diff changeset
184
482
e0d1eed4a46b misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 480
diff changeset
185 Many thanks to them.
0
goffi@necton2
parents:
diff changeset
186
1201
62135e3ca7ff misc: README typos fixes
Matteo Cypriani <mcy@lm7.fr>
parents: 1192
diff changeset
187 A big thanks 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
188
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
189
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
190 ** CONTACT **
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
191
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
192 You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually:
0
goffi@necton2
parents:
diff changeset
193
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
194 Goffi:
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
195 - goffi@goffi.org (e-mail)
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
196 - goffi@jabber.fr (jid)
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
197 - http://www.goffi.org (blog, with fresh news about SàT)
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
198
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
199 Souliane:
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
200 - souliane@mailoo.org (e-mail)
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
201 - souliane@libervia.org (jid)
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
202
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
203 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
204
1201
62135e3ca7ff misc: README typos fixes
Matteo Cypriani <mcy@lm7.fr>
parents: 1192
diff changeset
205 - 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
206 - 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
207 - 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
208 - mailing lists (lists.goffi.org)
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
209
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
210 and the official SàT website is at http://www.salut-a-toi.org
0
goffi@necton2
parents:
diff changeset
211
goffi@necton2
parents:
diff changeset
212
goffi@necton2
parents:
diff changeset
213
goffi@necton2
parents:
diff changeset
214 This software is dedicated to Roger Poisson.