diff README @ 24:61124cb82fb7

Updated README and licenses (for images), added installation instructions.
author Goffi <goffi@goffi.org>
date Tue, 01 Dec 2009 07:55:46 +0100
parents c4bc297b82f0
children f1db7ffbe6a7
line wrap: on
line diff
--- a/README	Tue Dec 01 06:07:20 2009 +0100
+++ b/README	Tue Dec 01 07:55:46 2009 +0100
@@ -50,15 +50,9 @@
 
 ** 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
+For installation instructions, please read the file "INSTALL".
 
-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
-
+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.
 
 
@@ -97,9 +91,21 @@
 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
 
+wokkel:
+SàT use a library with high level enhancements on top of twisted, which is called wokkel (http://wokkel.ik.nu). Lot of thanks to Ralph Meijer and all other contributors.
+
+wxWidgets & wxPython:
+The Wix frontend is made with wxWidgets (www.wxwidgets.org) and its python version wxPython (wxPython), which is a really handy UI toolkit who works on most popular platforms. It can be found on probably all major Gnu/Linux distributions. as usual, thanks to the authors.
+
+pictures found in frontends/wix/images:
+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/wix/images/LICENSE). Thanks to them.
+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
+
 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.
 
+If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
+