Not sure if PyGTK prereq should be specified here, but doing anyway...
[jben2_gui/jose.git] / README.txt
blob407c168ab0732b32cd0bba1abbb25076fe101351
1 J-Ben: a Japanese study program\r
2 Copyright 2007, 2008, 2009, 2010 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 "alpha" status and is not intended\r
6 for everyday use.\r
7 \r
8 \r
9 Installation:\r
11         python setup.py install\r
13 Running the program:\r
15         python -m jben.main\r
18 Summary of current status:\r
20   - The kanji and word dictionaries work at a basic level, but are by\r
21     no means fast.  They are pending cleanup if not a rewrite.  (I\r
22     knew much less about Python at the time I wrote them than I do\r
23     now.)\r
25   - Improvement over J-Ben 1.2.3: Startup time is nearly instantaneous\r
26     since dictionary data is not loaded until one of the dictionaries\r
27     is queried.\r
29   - The preferences menu, although present, does not actually do\r
30     anything meaningful yet.\r
32   - Most advanced features in the program are not yet present.  (Study\r
33     lists, kanji practice mode, character/word cross referencing.\r
35   - The program can be hooked into jben_kpengine for handwriting\r
36     recognition support.  However, the path is currently hardcoded.\r
37     This is a temporary situation; I plan on making a Python module\r
38     equivalent to that code in the future.\r
41 As always, feedback and patches are welcome.\r
43 - Paul\r