view README @ 37:49b40c9e6ba3

added MANIFEST to .hgignore
author Goffi <goffi@goffi.org>
date Tue, 28 Dec 2010 22:23:58 +0100
parents 875ff127b2dd
children 39c1448badd7
line wrap: on
line source

urwid-satext v0.1.0
(c) Jérôme Poisson aka Goffi 2008, 2009, 2010

urwid-satext, or urwid SàT extensions, is a widgets library based on Urwid



** LICENSE **

urwid-satext is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

urwid-satext 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with urwid-satext.  If not, see <http://www.gnu.org/licenses/>.




** WTF ? **
urwid-satext is a widgets based on top of the excellent Urwid (http://excess.org/urwid/) console user interface library.
It was originally made for the "Salut à Toi" project, an XMPP/Jabber multi-frontend client, but was eventually separated to be used by other urwid projects.


** Installation **

just type as root:
$ python setup.py install

** What are the widgets provided ? **


** How to use it ? **

You can see the documentation at http://wiki.goffi.org/wiki/urwid-satext .
Also check examples directory.

** Credit **

A big big thank to the authors/contributors of Urwid (http://excess.org/urwid/), 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.

If I forgot any credit (and I probably have), please contact me (mail below) to fix it.





** Contact **

You can contact me on goffi@goffi.org
my blog (in french) is at http://www.goffi.org
urwid-satext wiki page is at http://wiki.goffi.org/wiki/urwid-satext , you will find there link to the latests release, the repository, etc.