--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sat Aug 29 13:34:59 2009 +0200
@@ -0,0 +1,114 @@
+SàT
+(c) Jérôme Poisson aka Goffi 2008,2009
+
+SàT is a XMPP (Jabber) client.
+
+
+
+
+
+** LICENSE **
+
+SàT is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+SàT is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+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 !
+
+
+
+
+
+** 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.
+
+For the moment, the frontends are:
+
+* wix: a wxwidget frontend, the main graphical frontend
+* sortilège: a ncurses client, for screen lovers
+* jp: the command line toolkit. The tool for geeks by geeks
+
+other frontends planed in the near future:
+
+* a web frontend
+* a KDE 4 frontend, as KDE is my main desktop environment
+
+
+
+
+
+** How to use it ? **
+
+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).
+You must have the main dir (with sat inside) and frontend in your PYTHONPATH. For exemple, if you have uncompressed the soft in /tmp/useless_soft:
+
+$ export PYTHONPATH=$PYTHONPATH:/tmp/useless_soft:/tmp/useless_soft/frontends
+
+if you wants to access jp, it can be a good idea to export its dir to your PATH:
+
+$ export PATH=$PATH:/tmp/useless_soft/frontends/jp
+
+There will probably be a wiki doc in the future.
+
+
+
+
+
+** Misc **
+
+-- Shortcuts for sortilège (temporary):
+C-L: access contact list (enter to valid)
+F2: Show/Hide contact list
+C-S: Short representation of contacts in chat window
+C-C: Use colors... or not
+C-T: Timestamp
+C-X: Leave
+--
+
+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 ;)
+sortilège means "spell" in french, and it is ncurses based...
+wix come of course from the WX of wxwidgets and just sound cool :).
+
+
+
+
+
+** Credit **
+
+proxy65:
+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).
+As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code. Thanks a lot to them !
+
+progressbar:
+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. thanks to him
+
+twisted:
+SàT is based on the twisted framework (http://twistedmatrix.com/trac/), a very great tools which offer a lot of protocols management. There are too many contributors to name them here, so take a look on the website :). Again, thanks to them
+
+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/), etc. Thanks thanks thanks, thank to everybody in the Free (Libre) chain for making a part of the dream.
+
+
+
+
+
+** Contact **
+
+You can contact me on goffi@goffi.org . Yes I know, I don't give my JID ;)
+You'll find the latest version on my website: http://www.goffi.org (it's mainly in french, I will probably make a little part in english in the future).
+
+
+
+This software is dedicated to Roger Poisson.