Various refactoring Largely made button mode work
[dasher.git] / README
blob50b759bff33de27dd391d9d029378a2a8f39525e
1 Dasher version 3.99.0 (4.0 preview 1)
2 ------------------------------------- 
3 This is Dasher 3.99.0, the first preview release of the upcoming 4.0
4 series. It is development code, and should therefore be considered
5 potentially unstable, although we have done our best to make it as
6 usable as possible.
8 Dasher is a zooming predictive text entry system, designed for situations
9 where keyboard input is impractical (for instance, accessibility or PDAs). It
10 is usable with highly limited amounts of physical input while still allowing
11 high rates of text entry.
13 Dasher is Free software released under the GPL. Further documentation
14 may be found in the Doc/ subdirectory
16 New Features In 3.99.0
17 ----------------------
18  * Japanese Kanji text entry (See 'Kanji Entry' below)
20 Requirements
21 ------------
22 Dasher makes use of the following third party software (note that this
23 list is potentially inaccurate or incomplete - please send any
24 corrections to 'dasher@mrao.cam.ac.uk'):
26 General:
27  * The Expat XML parser (required)
29 Linux:
30  * Autotools (required, build only)
31  * Intltool (required, build only)
32  * Libtool (required, build only)
33  * GTK+ (2.2 or greated) (required)
34  * GNOME (optional, but highly recommended)
35  * GNOME Speech (optional)
36  * Libcanna (optional, for Hiragana to Kanji conversion)
38 MS Windows:
39  * MS Speech API (optional)
41 MS Windows CE:
42  * (not sure - if anyone knows then please fill this in)
44 Installation Instructions
45 -------------------------
46 Please see the file INSTALL.<platform> for details on how to build and install Dasher from source on your host system.
48 Font Support
49 ------------
50 Dasher includes some alphabets which require fonts that you probably don't 
51 have installed; for example, for the International Phonetic Alphabet, Korean
52 and Hiragana (Japanese).  We aren't legally allowed to distribute a font for
53 the IPA, but you can download one yourself from:  
55    http://www.sil.org/computing/fonts/encore-ipa.html
57 Kanji Entry
58 -----------
60 Dasher 3.99.0 contains experimental support for Japanese Kanji entry
61 by Hiragana conversion. To build Dasher with this enabled on Linux,
62 you need the libcanna conversion library. You also need to be able to
63 access a canna conversion server, which can be on the local machine or
64 over a network. Please note that Dasher will not start a canna server
65 if none is running - you must do so manually before running Dasher. 
66 Please see the Canna documentation for more details.
68 Kanji conversion in Microsoft Windows is via the IME API, which is
69 part of Windows XP and Asian builds of earlier Windows
70 versions. Support for Kanji conversion in Dasher under Windows is
71 still very much under development, so please take care when trying
72 it out. In particular, Dasher will crash if you try to enable Kanji
73 conversion on a machine which does not have Japanese localisation
74 installed.
76 To use Kanji conversion in Dasher, you must select 'Hiragana ... (For
77 use with Hapanese language model)' from the 'Alphabet' section of the
78 preferences dialogue, and the Japanese language model from the
79 'Prediction' section.
81 Support and Feedback
82 --------------------
83 Please file any bug reports in the GNOME Bugzilla system:
85 http://bugzilla.gnome.org/
87 using the 'dasher' package name. We also appreciate general feedback -
88 please send any comments to 'dasher@mrao.cam.ac.uk'.
90 You can find the Dasher website at:
92   http://www.inference.phy.cam.ac.uk/dasher/
94 Thank you for trying Dasher,
96 The Dasher Team