Updated jben's readme a bit, also fixed icon loading problems.
[jben2_gui.git] / jben / README.txt
blobfeb3c3f9db8ed3c9ee15d4cf8807fe9f9d25b47b
1 J-Ben: a Japanese study program\r
2 Copyright 2007, 2008, 2009 by Paul Goins\r
3 Released under the GNU General Public License (GPL), version 2 or above\r
4 \r
5 This program should be considered Pre-Alpha, as it does not yet\r
6 function even at a basic level as it is intended.  It is little more\r
7 than a GUI shell at this point.\r
8 \r
9 Installation:\r
11         python setup.py install\r
13 Running the program:\r
15         python -m jben.jben\r
17 At this point, a basic PyGTK GUI is operational and some user settings\r
18 will be saved in ~/.jben (POSIX) or "%APPDATA%\J-Ben Settings"\r
19 (Windows).  However, dictionaries are not yet linked into the program,\r
20 so it is not usable for practical purposes.\r
22 The program can be hooked into jben_kpengine.exe, but the path is\r
23 currently hardcoded.  This is a temporary situation; I plan on making\r
24 a Python module equivalent to that code.  However, people interesting\r
25 in testing things can do so; handwriting recognition does work if\r
26 J-Ben can find jben_kpengine.\r
28 Feedback and patches are welcome.\r
30 - Paul\r