Indentation fix (and an excuse to test the repo!)
[pyghosd.git] / README
blob9761a36f9879d62d22c5a65867944b4c9702ef49
1 pyghosd
2 =======
3 Sylvain Fourmanoit <syfou@users.sourceforge.net>
5 What is it?
6 -----------
7 It is a way to use the Ghosd library to flash text on screen from Python with
8 minimum fuss; unlike what the name might suggests, this does not contains Python
9 bindings to Ghosd.
11 Requirements 
12 ------------ 
13 - Ghosd 0.0.1 and its dependencies (i.e. if you can build Ghosd, you are fine)
14 - Python (tested on 2.4.4 and 2.5.1), including the development headers.
16 Compilation and Installation
17 ----------------------------
18 pyghosd comes with a distutils script. In most cases, it should be enough to
19 perform, with proper privileges:
21 -----------------------
22 python setup.py install
23 -----------------------
25 See `python setup.py --help` for details.
27 Usage
28 -----
29 See `pydoc ghosd` once pyghosd has been installed.
31 To Do
32 -----
33 - Add proper Unicode support.
35 Legalese
36 --------
37 See LICENSE.