Mercurial > urwid-satext

annotate README @ 151:6689aa54b20c default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
refactoring from camelCase -> snake_case: This libraries was using camelCase due for historical reasons (related to the use of Twisted in the initial project). This patch fixes it by using PEP8 compliant snake_case
author Goffi <goffi@goffi.org>
date Sat, 08 Apr 2023 15:38:18 +0200
parents d505d9ee792e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
130
406c310e52b5 0.7.0a1 release
Goffi <goffi@goffi.org>
parents: 125
diff changeset
1 urwid-satext
145
d505d9ee792e v0.8.0b1 release
Goffi <goffi@goffi.org>
parents: 140
diff changeset
2 (c) Jérôme Poisson aka Goffi 2008-2021
122
00b012549f88 copyright update
Goffi <goffi@goffi.org>
parents: 119
diff changeset
3 (c) Adrien Cossa 2014-2016
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
4
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
5 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
6
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
7
72
e497bf7e3060 version update
Goffi <goffi@goffi.org>
parents: 71
diff changeset
8 ** LICENCE **
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
9
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
10 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
11 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
12 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
13 (at your option) any later version.
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
14
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
15 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
16 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
17 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
18 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
19
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
20 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
21 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
22
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
23
72
e497bf7e3060 version update
Goffi <goffi@goffi.org>
parents: 71
diff changeset
24 ** About **
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
25 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
26 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
27
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
28
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
29 ** Installation **
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
30
102
ba19778eabf2 set the minimal version of urwid to 1.2.0
souliane <souliane@mailoo.org>
parents: 100
diff changeset
31 Install the dependency: urwid >= 1.2.0
ba19778eabf2 set the minimal version of urwid to 1.2.0
souliane <souliane@mailoo.org>
parents: 100
diff changeset
32
ba19778eabf2 set the minimal version of urwid to 1.2.0
souliane <souliane@mailoo.org>
parents: 100
diff changeset
33 Just type as root:
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
34 $ python setup.py install
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 ** What are the widgets provided ? **
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
37
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
38
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
39 ** How to use it ? **
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
40
34
875ff127b2dd - i18n management: gettext integration + french translation
Goffi <goffi@goffi.org>
parents: 30
diff changeset
41 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
42 Also check examples directory.
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
43
72
e497bf7e3060 version update
Goffi <goffi@goffi.org>
parents: 71
diff changeset
44
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
45 ** Credit **
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 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
48 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
49
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
50 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
51
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
52
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
53 ** Contact **
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
54
125
33cb9a05ff84 version update (0.6.1)
Goffi <goffi@goffi.org>
parents: 122
diff changeset
55 You can contact us on contact@salut-a-toi.org (e-mail)
72
e497bf7e3060 version update
Goffi <goffi@goffi.org>
parents: 71
diff changeset
56 SàT official site: http://www.salut-a-toi.org
125
33cb9a05ff84 version update (0.6.1)
Goffi <goffi@goffi.org>
parents: 122
diff changeset
57 Goffi's blog (french/english) is at http://www.goffi.org
30
1aeb3540aa49 files reorganisation after project separation. new README, and COPYING files
Goffi <goffi@goffi.org>
parents:
diff changeset
58 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.