Mercurial > libervia-backend

comparison README @ 2104:4f189bd1d9ed

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: README update
author Goffi <goffi@goffi.org>
date Sat, 24 Dec 2016 14:08:21 +0100
parents 43516c915ca6
children 8b37a62336c3
comparison
equal deleted inserted replaced
2103:b44558286bbb 2104:4f189bd1d9ed
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 technique 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 * primitivus: a console interface client, for screen lovers 31 * primitivus: a console interface client, for terminal lovers
32 * jp: the powerful command line toolkit. 32 * jp: the powerful command line toolkit.
33 * libervia: the web frontend. It's in a different package, check libervia on the wiki: http://wiki.goffi.org/wiki/Libervia 33 * libervia: the web frontend. It's in a different package, check libervia on the wiki: https://wiki.goffi.org/wiki/Libervia
34 * bellaciao: a Qt frontend at an early development stage 34 * cagou: the desktop/mobile frontend. It's in a different package
35 * bellaciao: a Qt frontend at an early development stage (development currently paused)
35 36
36 other frontends planed in the near future: 37 other frontends planed in the near future:
37 38
38 * mobile frontends, fuse frontend, etc. 39 * mobile frontends, fuse frontend, etc.
39 40
40 41
41 ** HOW TO USE IT ? ** 42 ** HOW TO USE IT ? **
42 43
43 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
44 45
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. 46 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.
46 47
47 48
48 ** MISC ** 49 ** MISC **
49 50
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: 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:
71 eval `/usr/local/bin/dbus-launch.sh` 72 eval `/usr/local/bin/dbus-launch.sh`
72 73
73 -- 74 --
74 75
75 You can find Primitivus shortcuts on the wiki: 76 You can find Primitivus shortcuts on the wiki:
76 http://wiki.goffi.org/wiki/Primitivus 77 https://wiki.goffi.org/wiki/Primitivus
77 78
78 -- 79 --
79 80
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. 81 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.
81 jp stands for "Jabber coPy" or "JumP". 82 jp stands for "Jabber coPy" or "JumP", and was choosen for its similarity with "cp" and short name.
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). 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 Libervia is made from "Liber" (libre) and via (road, path). It could be understood as the libre road, or the path to freedom.
85 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.
83 86
84 87
85 ** CREDIT ** 88 ** CREDIT **
86 89
87 A big big thank to the authors/contributors of... 90 A big big thank to the authors/contributors of...
102 Urwid: 105 Urwid:
103 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. 106 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.
104 107
105 Pyjamas: 108 Pyjamas:
106 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. 109 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.
110
111 Kivy and its linked tools (python-for-android, buildozer, plyer, pyjnius):
112 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,
113
114 Kivy garden:
115 in addition to Kivy itself, extension from the garden are used:
116 - contextmenu: used to display main and context menus
107 117
108 lxml(http://lxml.de/): 118 lxml(http://lxml.de/):
109 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. 119 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.
110 120
111 pillow(https://python-pillow.github.io/): 121 pillow(https://python-pillow.github.io/):
149 Used to follow FreeDesktop XDG standards 159 Used to follow FreeDesktop XDG standards
150 160
151 A special thank to people working on XMPP standards, libre standards are the way to go ! 161 A special thank to people working on XMPP standards, libre standards are the way to go !
152 162
153 and the others: 163 and the others:
154 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. 164 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.
155 165
156 If I forgot any credit (and I probably have), please contact me (mail below) to fix it. 166 If we forgot any credit (and we probably have), please contact us (mail below) to fix it.
157 167
158 168
159 ** CONTRIBUTORS ** 169 ** CONTRIBUTORS **
160 170
161 Salut à Toi has received contributions from: 171 Salut à Toi has received contributions from:
184 194
185 195
186 ** CONTACT ** 196 ** CONTACT **
187 197
188 You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually: 198 You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually:
199
200 SàT team:
201 - contact@salut-a-toi.invalid (replace invalid by org)
202 - https://libervia.org/blog/salut-a-toi (blog)
189 203
190 Goffi: 204 Goffi:
191 - goffi@goffi.org (e-mail) 205 - goffi@goffi.org (e-mail)
192 - goffi@jabber.fr (jid) 206 - goffi@jabber.fr (jid)
193 - http://www.goffi.org (blog, with fresh news about SàT) 207 - https://www.goffi.org (blog - based on Libervia -, with fresh news about SàT)
194 208
195 Souliane: 209 Souliane:
196 - souliane@mailoo.org (e-mail) 210 - souliane@mailoo.org (e-mail)
197 - souliane@libervia.org (jid) 211 - souliane@libervia.org (jid)
198 212
201 - wiki (wiki.goffi.org), in French & English so far 215 - wiki (wiki.goffi.org), in French & English so far
202 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects) 216 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
203 - bugtracker (bugs.goffi.org) to report any problem or give suggestions 217 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
204 - mailing lists (lists.goffi.org) 218 - mailing lists (lists.goffi.org)
205 219
206 and the official SàT website is at http://www.salut-a-toi.org 220 and the official SàT website is at https://www.salut-a-toi.org
207
208 221
209 222
210 This software is dedicated to Roger Poisson. 223 This software is dedicated to Roger Poisson.