diff README @ 871:5d08ab99e8dd

README and INSTALL updates
author Goffi <goffi@goffi.org>
date Wed, 26 Feb 2014 00:36:34 +0100
parents 4429bd7d5efb
children 1f5ad976fa32
line wrap: on
line diff
--- a/README	Tue Feb 25 23:45:50 2014 +0100
+++ b/README	Wed Feb 26 00:36:34 2014 +0100
@@ -5,9 +5,6 @@
 SàT is a XMPP (Jabber) client.
 
 
-
-
-
 ** LICENSE **
 
 SàT is free software: you can redistribute it and/or modify
@@ -24,45 +21,32 @@
 along with SàT.  If not, see <http://www.gnu.org/licenses/>.
 
 
-
-It is currently in a very alpha stage, and absolutely not usable for everyday use, use at your own risks !
-
-
+** ABOUT **
 
-
-
-** WTF ? **
-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.
+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.
+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).
 
 For the moment, the frontends are:
 
-* wix: a wxwidget frontend, the main graphical frontend
+* wix: based on WxWidgets, a minimal and old fashioned desktop frontend
 * primitivus: a console interface client, for screen lovers
-* jp: the command line toolkit. The tool for geeks by geeks
+* 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
 
 other frontends planed in the near future:
 
-* a KDE 4 frontend, as KDE is my main desktop environment
-
-
-
+* mobile frontends, fuse frontend, etc.
 
 
-** How to use it ? **
-
-For installation instructions, please read the file "INSTALL".
+** HOW TO USE IT ? **
 
-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.
+For installation instructions, please read the file "INSTALL". Note that SàT is available in several GNU/Linux distributions
 
-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).
-There will probably be a wiki doc in the future.
+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.
 
 
-
-
-
-** Misc **
+** MISC **
 
 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:
 $ eval `dbus-launch --sh-syntax`
@@ -95,18 +79,18 @@
 --
 
 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.
-jp stands for "Jabber coPy" or "JumP". If you look well, you can also find my initials ;)
+jp stands for "Jabber coPy" or "JumP".
 Primitivus is based on Urwid, and, according to their FAQ, "ur" is a german prefix for "ancestral or primal" (primitivus is latin word)
 wix come of course from the WX of wxwidgets and just sound cool :).
 
 
-** /!\ Privacy warning /!\ **
+** /!\ PRIVACY WARNING /!\ **
 
-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 .
-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.
+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 .
+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.
 
 
-** Credit **
+** CREDIT **
 
 A big big thank to the authors/contributors of...
 
@@ -151,11 +135,12 @@
 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
 
 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, thank 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 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.
 
 If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
 
-** Contributors **
+
+** CONTRIBUTORS **
 
 Salut à Toi has received contributions from:
 
@@ -175,18 +160,29 @@
 
 A big thanks also to all the maintainers of SàT packages
 
-** Contact **
+
+** CONTACT **
+
+You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually:
 
-You can contact me on goffi@goffi.org (e-mail) or goffi@jabber.fr (jid)
-You'll find the latest version and other stuffs on my *.goffi.org websites:
-- presentation (sat.goffi.org) the project presentation site
+Goffi:
+	- goffi@goffi.org (e-mail)
+	- goffi@jabber.fr (jid)
+	- http://www.goffi.org (blog, with fresh news about SàT)
+
+Souliane:
+	- souliane@mailoo.org (e-mail)
+	- souliane@libervia.org (jid)
+
+You'll find the latest version and other stuffs on *.goffi.org websites:
+
 - wiki (wiki.goffi.org), in french & english so far
 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
-- blog (www.goffi.org) for latest news (in french)
 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
-- various mailing lists (lists.goffi.org) are about to be created
+- mailing lists (lists.goffi.org)
+
+and the official SàT website is at http://www.salut-a-toi.org
 
 
 
 This software is dedicated to Roger Poisson.
-