changeset 2104:4f189bd1d9ed

misc: README update
author Goffi <goffi@goffi.org>
date Sat, 24 Dec 2016 14:08:21 +0100
parents b44558286bbb
children c96fe007ca41
files README
diffstat 1 files changed, 25 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/README	Thu Dec 22 18:10:36 2016 +0100
+++ b/README	Sat Dec 24 14:08:21 2016 +0100
@@ -28,10 +28,11 @@
 
 For the moment, the frontends are:
 
-* primitivus: a console interface client, for screen lovers
+* primitivus: a console interface client, for terminal lovers
 * jp: the powerful command line toolkit.
-* libervia: the web frontend. It's in a different package, check libervia on the wiki: http://wiki.goffi.org/wiki/Libervia
-* bellaciao: a Qt frontend at an early development stage
+* libervia: the web frontend. It's in a different package, check libervia on the wiki: https://wiki.goffi.org/wiki/Libervia
+* cagou: the desktop/mobile frontend. It's in a different package
+* bellaciao: a Qt frontend at an early development stage (development currently paused)
 
 other frontends planed in the near future:
 
@@ -42,7 +43,7 @@
 
 For installation instructions, please read the file "INSTALL". Note that SàT is available in several GNU/Linux distributions
 
-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.
+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.
 
 
 ** MISC **
@@ -73,13 +74,15 @@
 --
 
 You can find Primitivus shortcuts on the wiki:
-http://wiki.goffi.org/wiki/Primitivus
+https://wiki.goffi.org/wiki/Primitivus
 
 --
 
-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.
-jp stands for "Jabber coPy" or "JumP".
+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.
+jp stands for "Jabber coPy" or "JumP", and was choosen for its similarity with "cp" and short name.
 Primitivus is based on Urwid, and, according to their FAQ, "ur" is a German prefix for "ancestral or primal" (primitivus is a latin word).
+Libervia is made from "Liber" (libre) and via (road, path). It could be understood as the libre road, or the path to freedom.
+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.
 
 
 ** CREDIT **
@@ -105,6 +108,13 @@
 Pyjamas:
 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.
 
+Kivy and its linked tools (python-for-android, buildozer, plyer, pyjnius):
+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, 
+
+Kivy garden:
+in addition to Kivy itself, extension from the garden are used:
+- contextmenu: used to display main and context menus
+
 lxml(http://lxml.de/):
 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.
 
@@ -151,9 +161,9 @@
 A special thank to people working on XMPP standards, libre standards are the way to go !
 
 and the others:
-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.
+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.
 
-If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
+If we forgot any credit (and we probably have), please contact us (mail below) to fix it.
 
 
 ** CONTRIBUTORS **
@@ -187,10 +197,14 @@
 
 You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually:
 
+SàT team:
+	- contact@salut-a-toi.invalid (replace invalid by org)
+	- https://libervia.org/blog/salut-a-toi (blog)
+
 Goffi:
 	- goffi@goffi.org (e-mail)
 	- goffi@jabber.fr (jid)
-	- http://www.goffi.org (blog, with fresh news about SàT)
+	- https://www.goffi.org (blog - based on Libervia -, with fresh news about SàT)
 
 Souliane:
 	- souliane@mailoo.org (e-mail)
@@ -203,8 +217,7 @@
 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
 - mailing lists (lists.goffi.org)
 
-and the official SàT website is at http://www.salut-a-toi.org
-
+and the official SàT website is at https://www.salut-a-toi.org
 
 
 This software is dedicated to Roger Poisson.