Mercurial > libervia-backend

comparison README @ 874:1f5ad976fa32

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
some typos fixes in the README files
author souliane <souliane@mailoo.org>
date Wed, 26 Feb 2014 09:34:46 +0100
parents 5d08ab99e8dd
children 12cfa23c6ab9
comparison
equal deleted inserted replaced
873:36572b0a56e6 874:1f5ad976fa32
3 (c) Adrien Cossa aka Souliane 2013, 2014 3 (c) Adrien Cossa aka Souliane 2013, 2014
4 4
5 SàT is a XMPP (Jabber) client. 5 SàT is a XMPP (Jabber) client.
6 6
7 7
8 ** LICENSE ** 8 ** LICENCE **
9 9
10 SàT is free software: you can redistribute it and/or modify 10 SàT is free software: you can redistribute it and/or modify
11 it under the terms of the GNU Affero General Public License as published by 11 it under the terms of the GNU Affero General Public License as published by
12 the Free Software Foundation, either version 3 of the License, or 12 the Free Software Foundation, either version 3 of the License, or
13 (at your option) any later version. 13 (at your option) any later version.
22 22
23 23
24 ** ABOUT ** 24 ** ABOUT **
25 25
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. 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.
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 technic too). 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).
28 28
29 For the moment, the frontends are: 29 For the moment, the frontends are:
30 30
31 * wix: based on WxWidgets, a minimal and old fashioned desktop frontend 31 * wix: based on WxWidgets, a minimal and old fashioned desktop frontend
32 * primitivus: a console interface client, for screen lovers 32 * primitivus: a console interface client, for screen lovers
41 41
42 ** HOW TO USE IT ? ** 42 ** HOW TO USE IT ? **
43 43
44 For installation instructions, please read the file "INSTALL". Note that SàT is available in several GNU/Linux distributions 44 For installation instructions, please read the file "INSTALL". Note that SàT is available in several GNU/Linux distributions
45 45
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 availables websites. 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.
47 47
48 48
49 ** MISC ** 49 ** MISC **
50 50
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: 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:
52 $ eval `dbus-launch --sh-syntax` 52 $ eval `dbus-launch --sh-syntax`
53 53
54 Be careful to use the same environment variables if you start a new session. 54 Be careful to use the same environment variables if you start a new session.
55 55
56 I personnaly use the following script to do that automaticaly: 56 I personally use the following script to do that automatically:
57 57
58 --- /usr/local/bin/dbus-launch.sh --- 58 --- /usr/local/bin/dbus-launch.sh ---
59 #!/bin/sh 59 #!/bin/sh
60 60
61 DBUS_PATH="/tmp/.dbus.`whoami`" 61 DBUS_PATH="/tmp/.dbus.`whoami`"
76 You can find Primitivus shortcuts on the wiki: 76 You can find Primitivus shortcuts on the wiki:
77 http://wiki.goffi.org/wiki/Primitivus 77 http://wiki.goffi.org/wiki/Primitivus
78 78
79 -- 79 --
80 80
81 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. 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.
82 jp stands for "Jabber coPy" or "JumP". 82 jp stands for "Jabber coPy" or "JumP".
83 Primitivus is based on Urwid, and, according to their FAQ, "ur" is a german prefix for "ancestral or primal" (primitivus is latin word) 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)
84 wix come of course from the WX of wxwidgets and just sound cool :). 84 wix come of course from the WX of wxwidgets and just sound cool :).
85 85
86 86
87 ** /!\ PRIVACY WARNING /!\ ** 87 ** /!\ PRIVACY WARNING /!\ **
88 88
93 ** CREDIT ** 93 ** CREDIT **
94 94
95 A big big thank to the authors/contributors of... 95 A big big thank to the authors/contributors of...
96 96
97 proxy65: 97 proxy65:
98 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). 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).
99 As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code. 99 As the original MIT licence allow, the code is reused and sub-licenced until GPL v3 to follow the rest of the code.
100 100
101 progressbar: 101 progressbar:
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. 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.
103 103
104 twisted: 104 twisted:
112 112
113 Urwid: 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. 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.
115 115
116 Pyjamas: 116 Pyjamas:
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 throught a browser. It's really an amazing tool. 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.
118 118
119 Pyfeed and Xe: 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. 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 121
122 txJSON-RPC: 122 txJSON-RPC:
128 pictures found in frontends/src/wix/images/crystal/: 128 pictures found in frontends/src/wix/images/crystal/:
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). 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).
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 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
131 131
132 pictures found in frontends/src/wix/images/cards/ and /public/cards in Libervia: 132 pictures found in frontends/src/wix/images/cards/ and /public/cards in Libervia:
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 license, available under the same conditions. 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.
134 134
135 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture. 135 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
136 136
137 and the others: 137 and the others:
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. 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.
148 148
149 - Xavier Maillard <xavier@maillard.im>: bugs fixes. He's following the project for a while, maybe a future frontend contributor ? 149 - Xavier Maillard <xavier@maillard.im>: bugs fixes. He's following the project for a while, maybe a future frontend contributor ?
150 150
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. 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.
152 152
153 - Matthieu Rakotojaona <matthieu.rakotojaona@gmail.com>: English translation of the social contract. A great quality translation ! 153 - Matthieu Rakotojaona <matthieu.rakotojaona@gmail.com>: english translation of the social contract. A great quality translation !
154 154
155 - Thomas Preud'homme <robotux@debian.org>: bugs fixes. He's also one the maintainer of the Debian package. 155 - Thomas Preud'homme <robotux@debian.org>: bugs fixes. He's also one the maintainer of the Debian package.
156 156
157 - Dal <kedals0@gmail.com>: profiles management, argparse refactoring in jp 157 - Dal <kedals0@gmail.com>: profiles management, argparse refactoring in jp
158 158