Mercurial > libervia-backend
annotate README @ 1056:a5cfa9bb4541
tools (config): fixConfigOption creates the section if it doesn't exist
| author | souliane <souliane@mailoo.org> |
|---|---|
| date | Sun, 08 Jun 2014 17:27:03 +0200 |
| parents | 21681070f913 |
| children | c4b62e6b7377 |
| rev | line source |
|---|---|
| 887 | 1 SàT v0.4.1 |
| 811 | 2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011, 2012, 2013, 2014 |
|
816
4429bd7d5efb
misc (README): updated Link Mauve and Dal contributions, moved Souliane as a main contributor
Goffi <goffi@goffi.org>
parents:
811
diff
changeset
|
3 (c) Adrien Cossa aka Souliane 2013, 2014 |
| 0 | 4 |
| 5 SàT is a XMPP (Jabber) client. | |
| 6 | |
| 7 | |
|
874
1f5ad976fa32
some typos fixes in the README files
souliane <souliane@mailoo.org>
parents:
871
diff
changeset
|
8 ** LICENCE ** |
| 0 | 9 |
| 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 | 12 the Free Software Foundation, either version 3 of the License, or |
| 13 (at your option) any later version. | |
| 14 | |
| 15 SàT 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 | |
|
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 | 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 | 21 along with SàT. If not, see <http://www.gnu.org/licenses/>. |
| 22 | |
| 23 | |
| 871 | 24 ** ABOUT ** |
| 0 | 25 |
| 871 | 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 | 28 |
| 29 For the moment, the frontends are: | |
| 30 | |
| 871 | 31 * wix: based on WxWidgets, a minimal and old fashioned desktop frontend |
| 181 | 32 * primitivus: a console interface client, for screen lovers |
| 871 | 33 * jp: the powerful command line toolkit. |
| 348 | 34 * libervia: the web frontend. It's in a different package, check libervia on the wiki: http://wiki.goffi.org/wiki/Libervia |
| 871 | 35 * bellaciao: a Qt frontend at an early development stage |
| 0 | 36 |
| 37 other frontends planed in the near future: | |
| 38 | |
| 871 | 39 * mobile frontends, fuse frontend, etc. |
| 0 | 40 |
| 41 | |
| 871 | 42 ** HOW TO USE IT ? ** |
| 0 | 43 |
| 871 | 44 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
|
45 |
|
874
1f5ad976fa32
some typos fixes in the README files
souliane <souliane@mailoo.org>
parents:
871
diff
changeset
|
46 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 | 47 |
| 48 | |
| 871 | 49 ** MISC ** |
| 0 | 50 |
|
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
|
51 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
|
52 $ 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
|
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 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
|
55 |
|
874
1f5ad976fa32
some typos fixes in the README files
souliane <souliane@mailoo.org>
parents:
871
diff
changeset
|
56 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
|
57 |
|
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 --- /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
|
59 #!/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
|
60 |
|
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 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
|
62 |
|
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 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
|
64 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
|
65 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
|
66 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
|
67 |
|
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 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
|
69 --- 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
|
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 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
|
72 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
|
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 -- |
|
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
|
75 |
|
587
952322b1d490
Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
581
diff
changeset
|
76 You can find Primitivus shortcuts on the wiki: |
| 348 | 77 http://wiki.goffi.org/wiki/Primitivus |
| 78 | |
| 0 | 79 -- |
| 80 | |
|
874
1f5ad976fa32
some typos fixes in the README files
souliane <souliane@mailoo.org>
parents:
871
diff
changeset
|
81 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 | 82 jp stands for "Jabber coPy" or "JumP". |
|
874
1f5ad976fa32
some typos fixes in the README files
souliane <souliane@mailoo.org>
parents:
871
diff
changeset
|
83 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 | 84 wix come of course from the WX of wxwidgets and just sound cool :). |
| 85 | |
| 86 | |
| 871 | 87 ** /!\ PRIVACY WARNING /!\ ** |
| 0 | 88 |
| 871 | 89 To make setup easier, SàT ask 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 . |
| 90 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 | 91 |
| 92 | |
| 871 | 93 ** CREDIT ** |
| 0 | 94 |
| 181 | 95 A big big thank to the authors/contributors of... |
| 96 | |
| 0 | 97 proxy65: |
|
874
1f5ad976fa32
some typos fixes in the README files
souliane <souliane@mailoo.org>
parents:
871
diff
changeset
|
98 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). |
|
1f5ad976fa32
some typos fixes in the README files
souliane <souliane@mailoo.org>
parents:
871
diff
changeset
|
99 As the original MIT licence allow, the code is reused and sub-licenced until GPL v3 to follow the rest of the code. |
| 0 | 100 |
| 101 progressbar: | |
| 181 | 102 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 | 103 |
| 104 twisted: | |
| 348 | 105 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 | 106 |
|
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
107 wokkel: |
|
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
108 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
|
109 |
|
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
110 wxWidgets & wxPython: |
| 181 | 111 The Wix frontend is made with wxWidgets (www.wxwidgets.org) and its python version wxPython (wxPython), which is a really handy UI toolkit who works on most popular platforms. It can be found on probably all major Gnu/Linux distributions. |
| 112 | |
| 113 Urwid: | |
| 114 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
|
115 |
| 348 | 116 Pyjamas: |
|
874
1f5ad976fa32
some typos fixes in the README files
souliane <souliane@mailoo.org>
parents:
871
diff
changeset
|
117 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 | 118 |
| 119 Pyfeed and Xe: | |
| 120 SàT core and Libervia use pyfeed and xe (http://www.blarg.net/%7Esteveha/), 2 libraries made Steve R. Hastings really useful to parse/generate xml stuff as atom feeds. | |
| 121 | |
| 122 txJSON-RPC: | |
| 123 Libervia use txJSON-RPC (https://launchpad.net/txjsonrpc), a twisted library to communicate with the browser's javascript throught JSON-RPC | |
| 124 | |
|
578
28331ecf0a65
misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents:
576
diff
changeset
|
125 Mutagen: |
|
28331ecf0a65
misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents:
576
diff
changeset
|
126 Mutagen (https://code.google.com/p/mutagen/) is an audio metadata handling library, it's use by the radiocol plugin. |
|
28331ecf0a65
misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents:
576
diff
changeset
|
127 |
|
322
2b9b6b6ec717
README: fixed paths, and added personnal jid
Goffi <goffi@goffi.org>
parents:
245
diff
changeset
|
128 pictures found in frontends/src/wix/images/crystal/: |
|
2b9b6b6ec717
README: fixed paths, and added personnal jid
Goffi <goffi@goffi.org>
parents:
245
diff
changeset
|
129 These pictures come from Crystal clear, were made by Everaldo Coelho (www.everaldo.com) and YellowIcon (www.yellowicon.com). They are under LGPL V3 licence (see frontends/src/wix/images/COPYING.LESSER). |
|
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
130 Found on http://commons.wikimedia.org/wiki/File:Crystal_Clear_app_browser.png and http://commons.wikimedia.org/wiki/File:Crystal_Clear_app_cache.png |
|
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
131 |
| 348 | 132 pictures found in frontends/src/wix/images/cards/ and /public/cards in Libervia: |
|
874
1f5ad976fa32
some typos fixes in the README files
souliane <souliane@mailoo.org>
parents:
871
diff
changeset
|
133 The Tarot cards pictures come from the deck found on wikicommons (the script used to cut them is available at frontend/src/wix/images/split_card.sh), and available at http://upload.wikimedia.org/wikipedia/commons/8/8d/Tarotcards.jpg under Creative Commons BY-SA. The authors shown on the site are Piast and Svick. The splitted cards are, according to the licence, available under the same conditions. |
| 181 | 134 |
| 135 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture. | |
| 136 | |
| 0 | 137 and the others: |
| 871 | 138 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 | 139 |
|
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
140 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
|
141 |
| 871 | 142 |
| 143 ** CONTRIBUTORS ** | |
| 0 | 144 |
|
482
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
145 Salut à Toi has received contributions from: |
|
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
146 |
|
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
147 - Adrien Vigneron <adrienvigneron@mailoo.org>: huge work on Libervia's CSS, SàT Logo (the mascot is its work), and Quiz game graphisms. He's friendly and talented, his work is really appreciated. |
| 0 | 148 |
|
482
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
149 - Xavier Maillard <xavier@maillard.im>: bugs fixes. He's following the project for a while, maybe a future frontend contributor ? |
| 0 | 150 |
|
816
4429bd7d5efb
misc (README): updated Link Mauve and Dal contributions, moved Souliane as a main contributor
Goffi <goffi@goffi.org>
parents:
811
diff
changeset
|
151 - 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
|
152 |
|
874
1f5ad976fa32
some typos fixes in the README files
souliane <souliane@mailoo.org>
parents:
871
diff
changeset
|
153 - 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
|
154 |
|
614
bef0f893482f
misc: added Thomas Preud'homme to contributors + a thanks message to maintainers =)
Goffi <goffi@goffi.org>
parents:
587
diff
changeset
|
155 - Thomas Preud'homme <robotux@debian.org>: bugs fixes. He's also one the maintainer of the Debian package. |
|
bef0f893482f
misc: added Thomas Preud'homme to contributors + a thanks message to maintainers =)
Goffi <goffi@goffi.org>
parents:
587
diff
changeset
|
156 |
|
816
4429bd7d5efb
misc (README): updated Link Mauve and Dal contributions, moved Souliane as a main contributor
Goffi <goffi@goffi.org>
parents:
811
diff
changeset
|
157 - Dal <kedals0@gmail.com>: profiles management, argparse refactoring in jp |
| 658 | 158 |
| 900 | 159 - Matteo Cypriani <mcy@lm7.fr>: jp's mainloop update + doc improvments |
| 160 | |
|
482
e0d1eed4a46b
misc: updated README with contributors
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
161 Many thanks to them. |
| 0 | 162 |
|
614
bef0f893482f
misc: added Thomas Preud'homme to contributors + a thanks message to maintainers =)
Goffi <goffi@goffi.org>
parents:
587
diff
changeset
|
163 A big thanks also to all the maintainers of SàT packages |
|
bef0f893482f
misc: added Thomas Preud'homme to contributors + a thanks message to maintainers =)
Goffi <goffi@goffi.org>
parents:
587
diff
changeset
|
164 |
| 871 | 165 |
| 166 ** CONTACT ** | |
| 167 | |
| 168 You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually: | |
| 0 | 169 |
| 871 | 170 Goffi: |
| 171 - goffi@goffi.org (e-mail) | |
| 172 - goffi@jabber.fr (jid) | |
| 173 - http://www.goffi.org (blog, with fresh news about SàT) | |
| 174 | |
| 175 Souliane: | |
| 176 - souliane@mailoo.org (e-mail) | |
| 177 - souliane@libervia.org (jid) | |
| 178 | |
| 179 You'll find the latest version and other stuffs on *.goffi.org websites: | |
| 180 | |
|
238
83d2bc0abf2a
version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents:
228
diff
changeset
|
181 - wiki (wiki.goffi.org), in french & english so far |
|
83d2bc0abf2a
version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents:
228
diff
changeset
|
182 - 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
|
183 - bugtracker (bugs.goffi.org) to report any problem or give suggestions |
| 871 | 184 - mailing lists (lists.goffi.org) |
| 185 | |
| 186 and the official SàT website is at http://www.salut-a-toi.org | |
| 0 | 187 |
| 188 | |
| 189 | |
| 190 This software is dedicated to Roger Poisson. |