comparison README @ 348:8ff113e2abcb

updated README and CHANGELOG
author Goffi <goffi@goffi.org>
date Mon, 30 May 2011 16:16:46 +0200
parents 2b9b6b6ec717
children d98b7391d76c
comparison
equal deleted inserted replaced
347:ea3e1b82dd79 348:8ff113e2abcb
1 SàT v0.1.1 1 SàT v0.2.0
2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011 2 (c) Jérôme Poisson aka Goffi 2008, 2009, 2010, 2011
3 3
4 SàT is a XMPP (Jabber) client. 4 SàT is a XMPP (Jabber) client.
5 5
6 6
36 For the moment, the frontends are: 36 For the moment, the frontends are:
37 37
38 * wix: a wxwidget frontend, the main graphical frontend 38 * wix: a wxwidget frontend, the main graphical frontend
39 * primitivus: a console interface client, for screen lovers 39 * primitivus: a console interface client, for screen lovers
40 * jp: the command line toolkit. The tool for geeks by geeks 40 * jp: the command line toolkit. The tool for geeks by geeks
41 * libervia: the web frontend. It's in a different package, check libervia on the wiki: http://wiki.goffi.org/wiki/Libervia
41 42
42 other frontends planed in the near future: 43 other frontends planed in the near future:
43 44
44 * a web frontend
45 * a KDE 4 frontend, as KDE is my main desktop environment 45 * a KDE 4 frontend, as KDE is my main desktop environment
46 46
47 47
48 48
49 49
60 60
61 61
62 62
63 63
64 ** Misc ** 64 ** Misc **
65
66 You can find Primitivus shortcuts on the wiki:
67 http://wiki.goffi.org/wiki/Primitivus
65 68
66 -- Shortcuts for Primitivus (temporary): 69 -- Shortcuts for Primitivus (temporary):
67 C stands for "Ctrl" 70 C stands for "Ctrl"
68 M stands for Meta wich is usually the "Alt" key 71 M stands for Meta wich is usually the "Alt" key
69 S stands for "Shift" 72 S stands for "Shift"
118 121
119 progressbar: 122 progressbar:
120 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. 123 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.
121 124
122 twisted: 125 twisted:
123 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 :). 126 SàT is heavily based on the twisted framework (http://twistedmatrix.com/trac/), a very great tool which offer a lot of protocols management. There are too many contributors to name them here, so take a look on the website :).
124 127
125 wokkel: 128 wokkel:
126 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. 129 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.
127 130
128 wxWidgets & wxPython: 131 wxWidgets & wxPython:
129 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. 132 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.
130 133
131 Urwid: 134 Urwid:
132 Primitivus is based on Urwid (http://excess.org/urwid/) which saved me a lot of time. It's really a great library to easily make a sophisticated interface. 135 Primitivus is based on Urwid (http://excess.org/urwid/) which saved me a lot of time. It's really a great library to easily make a sophisticated interface.
133 136
137 Pyjamas:
138 Libervia is built with a Pyjamas (http://pyjs.org), a Google Web Toolkit port for python, including Python to Javascript compiler, and Pyjamas Desktop which allow to execute the same application on the desktop or throught a browser. It's really an amazing tool.
139
140 Pyfeed and Xe:
141 SàT core and Libervia use pyfeed and xe (http://www.blarg.net/%7Esteveha/), 2 libraries made Steve R. Hastings really useful to parse/generate xml stuff as atom feeds.
142
143 txJSON-RPC:
144 Libervia use txJSON-RPC (https://launchpad.net/txjsonrpc), a twisted library to communicate with the browser's javascript throught JSON-RPC
145
134 pictures found in frontends/src/wix/images/crystal/: 146 pictures found in frontends/src/wix/images/crystal/:
135 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/src/wix/images/COPYING.LESSER). 147 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/src/wix/images/COPYING.LESSER).
136 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 148 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
137 149
138 pictures found in frontends/src/wix/images/cards/ : 150 pictures found in frontends/src/wix/images/cards/ and /public/cards in Libervia:
139 The Tarot cards pictures come from the deck found on wikicommons (the script used to cut them is available at frontend/src/wix/images/split_card.sh), and available at http://upload.wikimedia.org/wikipedia/commons/8/8d/Tarotcards.jpg under Creative Commons BY-SA. The authors shown on the site are Piast and Svick. The splitted cards are, according to the license, available under the same conditions. 151 The Tarot cards pictures come from the deck found on wikicommons (the script used to cut them is available at frontend/src/wix/images/split_card.sh), and available at http://upload.wikimedia.org/wikipedia/commons/8/8d/Tarotcards.jpg under Creative Commons BY-SA. The authors shown on the site are Piast and Svick. The splitted cards are, according to the license, available under the same conditions.
140 152
141 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture. 153 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
142 154
143 and the others: 155 and the others: