Mercurial > urwid-satext

annotate README @ 85:e0c8274f9b1c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added ability to replace shortcuts
author Goffi <goffi@goffi.org>
date Thu, 04 Sep 2014 17:13:19 +0200
parents e497bf7e3060
children 4629924c136f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
72
e497bf7e3060 version update
Goffi <goffi@goffi.org>
parents: 71
diff changeset
1 urwid-satext v0.3.0
e497bf7e3060 version update
Goffi <goffi@goffi.org>
parents: 71
diff changeset
2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011, 2012, 2013, 2014
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
3
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
4 urwid-satext, or urwid SàT extensions, is a widgets library based on Urwid
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
5
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
6
72
e497bf7e3060 version update
Goffi <goffi@goffi.org>
parents: 71
diff changeset
7 ** LICENCE **
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
8
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
9 urwid-satext is free software: you can redistribute it and/or modify
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
10 it under the terms of the GNU Lesser General Public License as published by
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
11 the Free Software Foundation, either version 3 of the License, or
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
12 (at your option) any later version.
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
13
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
14 urwid-satext is distributed in the hope that it will be useful,
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
17 GNU Lesser General Public License for more details.
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
18
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
19 You should have received a copy of the GNU Lesser General Public License
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
20 along with urwid-satext. If not, see <http://www.gnu.org/licenses/>.
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
21
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
22
72
e497bf7e3060 version update
Goffi <goffi@goffi.org>
parents: 71
diff changeset
23 ** About **
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
24 urwid-satext is a widgets based on top of the excellent Urwid (http://excess.org/urwid/) console user interface library.
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
25 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.
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
26
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
27
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
28 ** Installation **
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
29
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
30 just type as root:
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
31 $ python setup.py install
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
32
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
33 ** What are the widgets provided ? **
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
34
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
35
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
36 ** How to use it ? **
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
37
34
875ff127b2dd - i18n management: gettext integration + french translation
Goffi <goffi@goffi.org>
parents: 30
diff changeset
38 You can see the documentation at http://wiki.goffi.org/wiki/urwid-satext .
875ff127b2dd - i18n management: gettext integration + french translation
Goffi <goffi@goffi.org>
parents: 30
diff changeset
39 Also check examples directory.
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
40
72
e497bf7e3060 version update
Goffi <goffi@goffi.org>
parents: 71
diff changeset
41
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
42 ** Credit **
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
43
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
44 A big big thank to the authors/contributors of Urwid (http://excess.org/urwid/), of course.
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
45 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.
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
46
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
47 If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
48
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
49
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
50 ** Contact **
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
51
72
e497bf7e3060 version update
Goffi <goffi@goffi.org>
parents: 71
diff changeset
52 You can contact me on goffi@goffi.org (e-mail) or goffi@jabber.fr (xmpp)
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
53 my blog (in french) is at http://www.goffi.org
72
e497bf7e3060 version update
Goffi <goffi@goffi.org>
parents: 71
diff changeset
54 SàT official site: http://www.salut-a-toi.org
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
55 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.