Mercurial > libervia-backend

annotate README @ 581:78ca32cc0b51

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
CHANGELOG + version updates (yes, that's a release \o/)
author Goffi <goffi@goffi.org>
date Wed, 09 Jan 2013 22:55:59 +0100
parents 28331ecf0a65
children 952322b1d490
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
581
78ca32cc0b51 CHANGELOG + version updates (yes, that's a release \o/)
Goffi <goffi@goffi.org>
parents: 578
diff changeset
1 SàT v0.3.0
572
ca13633d3b6b dates update
Goffi <goffi@goffi.org>
parents: 533
diff changeset
2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011, 2012, 2013
0
goffi@necton2
parents:
diff changeset
3
goffi@necton2
parents:
diff changeset
4 SàT is a XMPP (Jabber) client.
goffi@necton2
parents:
diff changeset
5
goffi@necton2
parents:
diff changeset
6
goffi@necton2
parents:
diff changeset
7
goffi@necton2
parents:
diff changeset
8
goffi@necton2
parents:
diff changeset
9
goffi@necton2
parents:
diff changeset
10 ** LICENSE **
goffi@necton2
parents:
diff changeset
11
goffi@necton2
parents:
diff changeset
12 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
13 it under the terms of the GNU Affero General Public License as published by
0
goffi@necton2
parents:
diff changeset
14 the Free Software Foundation, either version 3 of the License, or
goffi@necton2
parents:
diff changeset
15 (at your option) any later version.
goffi@necton2
parents:
diff changeset
16
goffi@necton2
parents:
diff changeset
17 SàT is distributed in the hope that it will be useful,
goffi@necton2
parents:
diff changeset
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
goffi@necton2
parents:
diff changeset
19 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
20 GNU Affero General Public License for more details.
0
goffi@necton2
parents:
diff changeset
21
480
2a072735e459 Licence modification: the full project is now under AGPL v3+ instead of GPL v3+
Goffi <goffi@goffi.org>
parents: 459
diff changeset
22 You should have received a copy of the GNU Affero General Public License
0
goffi@necton2
parents:
diff changeset
23 along with SàT. If not, see <http://www.gnu.org/licenses/>.
goffi@necton2
parents:
diff changeset
24
goffi@necton2
parents:
diff changeset
25
goffi@necton2
parents:
diff changeset
26
goffi@necton2
parents:
diff changeset
27 It is currently in a very alpha stage, and absolutely not usable for everyday use, use at your own risks !
goffi@necton2
parents:
diff changeset
28
goffi@necton2
parents:
diff changeset
29
goffi@necton2
parents:
diff changeset
30
goffi@necton2
parents:
diff changeset
31
goffi@necton2
parents:
diff changeset
32
goffi@necton2
parents:
diff changeset
33 ** WTF ? **
goffi@necton2
parents:
diff changeset
34 SàT is a XMPP (Jabber) client, made on a daemon/frontend architecture. Its aim is not only to be an instant messagery client: XMPP offer a lot more, and differents tools will come in the future.
goffi@necton2
parents:
diff changeset
35
goffi@necton2
parents:
diff changeset
36 For the moment, the frontends are:
goffi@necton2
parents:
diff changeset
37
goffi@necton2
parents:
diff changeset
38 * wix: a wxwidget frontend, the main graphical frontend
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
39 * primitivus: a console interface client, for screen lovers
0
goffi@necton2
parents:
diff changeset
40 * jp: the command line toolkit. The tool for geeks by geeks
348
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
41 * libervia: the web frontend. It's in a different package, check libervia on the wiki: http://wiki.goffi.org/wiki/Libervia
0
goffi@necton2
parents:
diff changeset
42
goffi@necton2
parents:
diff changeset
43 other frontends planed in the near future:
goffi@necton2
parents:
diff changeset
44
goffi@necton2
parents:
diff changeset
45 * a KDE 4 frontend, as KDE is my main desktop environment
goffi@necton2
parents:
diff changeset
46
goffi@necton2
parents:
diff changeset
47
goffi@necton2
parents:
diff changeset
48
goffi@necton2
parents:
diff changeset
49
goffi@necton2
parents:
diff changeset
50
goffi@necton2
parents:
diff changeset
51 ** How to use it ? **
goffi@necton2
parents:
diff changeset
52
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
53 For installation instructions, please read the file "INSTALL".
0
goffi@necton2
parents:
diff changeset
54
238
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
55 A wiki is available online (http://wiki.goffi.org), in french and english so far (I would appreciate any help for other languages). You can also have a look at the bottom of this files (in contact section) for other availables websites.
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
56
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
57 SàT is really at an early dev stage, so it's maybe the buggiest software you have ever seen, and there are for the moment absolutely nothing to ease the installation and use (but it will be the case ASAP, one of the goal of the project is the ease of use).
0
goffi@necton2
parents:
diff changeset
58 There will probably be a wiki doc in the future.
goffi@necton2
parents:
diff changeset
59
goffi@necton2
parents:
diff changeset
60
goffi@necton2
parents:
diff changeset
61
goffi@necton2
parents:
diff changeset
62
goffi@necton2
parents:
diff changeset
63
goffi@necton2
parents:
diff changeset
64 ** Misc **
goffi@necton2
parents:
diff changeset
65
348
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
66 You can find Primitivus shortcuts on the wiki:
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
67 http://wiki.goffi.org/wiki/Primitivus
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
68
0
goffi@necton2
parents:
diff changeset
69 --
goffi@necton2
parents:
diff changeset
70
goffi@necton2
parents:
diff changeset
71 SàT is the acronym (yes another one :( ) in tribute to the song Salut à Toi from the Bérurier Noir band. I recommand also the excelent cover from Les Ogres de Barback.
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
72 jp stands for "Jabber coPy" or "JumP". If you look well, you can also find my initials ;)
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
73 Primitivus is based on Urwid, and, according to their FAQ, "ur" is a german prefix for "ancestral or primal" (primitivus is latin word)
0
goffi@necton2
parents:
diff changeset
74 wix come of course from the WX of wxwidgets and just sound cool :).
goffi@necton2
parents:
diff changeset
75
goffi@necton2
parents:
diff changeset
76
31
7b34ffa2ff45 Updated README and added CHANGELOG
Goffi <goffi@goffi.org>
parents: 27
diff changeset
77 ** /!\ Privacy warning /!\ **
0
goffi@necton2
parents:
diff changeset
78
31
7b34ffa2ff45 Updated README and added CHANGELOG
Goffi <goffi@goffi.org>
parents: 27
diff changeset
79 To make setup easier, SàT ask my 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 .
533
52ab19ea940e misc: added informations on Apache logs in README's privacy warning
Goffi <goffi@goffi.org>
parents: 482
diff changeset
80 The IP will appear in my 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
81
goffi@necton2
parents:
diff changeset
82
goffi@necton2
parents:
diff changeset
83 ** Credit **
goffi@necton2
parents:
diff changeset
84
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
85 A big big thank to the authors/contributors of...
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
86
0
goffi@necton2
parents:
diff changeset
87 proxy65:
goffi@necton2
parents:
diff changeset
88 SàT (plugin_xep_0065) use nearly all the code from proxy65 (http://code.google.com/p/proxy65/) wich was coded by Dave Smith (2002-2004) and maintained by Fabio Forno (2007-2008).
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
89 As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code.
0
goffi@necton2
parents:
diff changeset
90
goffi@necton2
parents:
diff changeset
91 progressbar:
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
92 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
93
goffi@necton2
parents:
diff changeset
94 twisted:
348
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
95 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
96
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
97 wokkel:
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
98 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
99
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
100 wxWidgets & wxPython:
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
101 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.
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
102
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
103 Urwid:
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
104 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
105
348
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
106 Pyjamas:
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
107 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 throught a browser. It's really an amazing tool.
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
108
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
109 Pyfeed and Xe:
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
110 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.
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
111
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
112 txJSON-RPC:
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
113 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
114
578
28331ecf0a65 misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents: 576
diff changeset
115 Mutagen:
28331ecf0a65 misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents: 576
diff changeset
116 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
117
322
2b9b6b6ec717 README: fixed paths, and added personnal jid
Goffi <goffi@goffi.org>
parents: 245
diff changeset
118 pictures found in frontends/src/wix/images/crystal/:
2b9b6b6ec717 README: fixed paths, and added personnal jid
Goffi <goffi@goffi.org>
parents: 245
diff changeset
119 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
120 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
121
348
8ff113e2abcb updated README and CHANGELOG
Goffi <goffi@goffi.org>
parents: 322
diff changeset
122 pictures found in frontends/src/wix/images/cards/ and /public/cards in Libervia:
322
2b9b6b6ec717 README: fixed paths, and added personnal jid
Goffi <goffi@goffi.org>
parents: 245
diff changeset
123 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 license, available under the same conditions.
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
124
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
125 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
126
0
goffi@necton2
parents:
diff changeset
127 and the others:
181
a566f654929e README update:
Goffi <goffi@goffi.org>
parents: 57
diff changeset
128 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, thank to everybody in the Free (Libre) chain for making a part of the dream.
0
goffi@necton2
parents:
diff changeset
129
24
61124cb82fb7 Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
130 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
131
482
e0d1eed4a46b misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 480
diff changeset
132 ** Contributors **
0
goffi@necton2
parents:
diff changeset
133
482
e0d1eed4a46b misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 480
diff changeset
134 Salut à Toi has received contributions from:
e0d1eed4a46b misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 480
diff changeset
135
e0d1eed4a46b misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 480
diff changeset
136 - 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
goffi@necton2
parents:
diff changeset
137
482
e0d1eed4a46b misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 480
diff changeset
138 - 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
139
482
e0d1eed4a46b misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 480
diff changeset
140 - Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>: bugs fixes. A guy always around XMPP projects, he plan to work on a non D-Bus bridge.
e0d1eed4a46b misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 480
diff changeset
141
e0d1eed4a46b misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 480
diff changeset
142 - Matthieu Rakotojaona <matthieu.rakotojaona@gmail.com>: English translation of the social contract. A great quality translation !
e0d1eed4a46b misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 480
diff changeset
143
e0d1eed4a46b misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 480
diff changeset
144 Many thanks to them.
0
goffi@necton2
parents:
diff changeset
145
goffi@necton2
parents:
diff changeset
146 ** Contact **
goffi@necton2
parents:
diff changeset
147
322
2b9b6b6ec717 README: fixed paths, and added personnal jid
Goffi <goffi@goffi.org>
parents: 245
diff changeset
148 You can contact me on goffi@goffi.org (e-mail) or goffi@jabber.fr (jid)
238
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
149 You'll find the latest version and other stuffs on my *.goffi.org websites:
576
a60dd719e048 misc: added presentation website to README
Goffi <goffi@goffi.org>
parents: 572
diff changeset
150 - presentation (sat.goffi.org) the project presentation site
238
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
151 - wiki (wiki.goffi.org), in french & english so far
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
152 - 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
153 - blog (www.goffi.org) for latest news (in french)
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
154 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
155 - various mailing lists (lists.goffi.org) are about to be created
0
goffi@necton2
parents:
diff changeset
156
goffi@necton2
parents:
diff changeset
157
goffi@necton2
parents:
diff changeset
158
goffi@necton2
parents:
diff changeset
159 This software is dedicated to Roger Poisson.
57
a5b5fb5fc9fd updated README and copyright note
Goffi <goffi@goffi.org>
parents: 31
diff changeset
160