Various small changes
[dasher.git] / README
bloba7e27fad72fc7f9b3e2c4d887b4e60c4c3ed9c95
1 Dasher Version 4.3.0
2 --------------------
4 This is Dasher 4.3.0, the start of the development series leading up
5 to 4.4. For a stable version of Dasher, please download a release from
6 the 4.0 or 4.2 series.
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 Requirements
17 ------------
18 Dasher makes use of the following third party software (note that this
19 list is potentially inaccurate or incomplete - please send any
20 corrections to 'dasher@mrao.cam.ac.uk'):
22 General:
23  * The Expat XML parser (required)
25 Linux:
26  * Autotools (required, build only)
27  * Intltool (required, build only)
28  * Libtool (required, build only)
29  * GTK+ (2.2 or greated) (required)
30  * GNOME (optional, but highly recommended)
31  * GNOME Speech (optional)
32  * Libcanna (optional, for Hiragana to Kanji conversion)
34 MS Windows:
35  * MS Speech API (optional)
36  * MS Table API (optional - required for tablet start/stop mode)
38 MS Windows CE:
39  * (not sure - if anyone knows then please fill this in)
41 Installation Instructions
42 -------------------------
43 Please see the file INSTALL.<platform> for details on how to build and
44 install Dasher from source on your host system.
46 Font Support
47 ------------
48 Dasher includes some alphabets which require fonts that you probably don't 
49 have installed; for example, for the International Phonetic Alphabet, Korean
50 and Hiragana (Japanese).  We aren't legally allowed to distribute a font for
51 the IPA, but you can download one yourself from:  
53    http://www.sil.org/computing/fonts/encore-ipa.html
55 Kanji Entry
56 -----------
58 As of Dasher 3.99.0, experimental support for Japanese Kanji entry
59 by Hiragana conversion. To build Dasher with this enabled on Linux,
60 you need the libcanna conversion library. You also need to be able to
61 access a canna conversion server, which can be on the local machine or
62 over a network. Please note that Dasher will not start a canna server
63 if none is running - you must do so manually before running Dasher. 
64 Please see the Canna documentation for more details.
66 Kanji conversion in Microsoft Windows is via the IME API, which is
67 part of Windows XP and Asian builds of earlier Windows
68 versions. Support for Kanji conversion in Dasher under Windows is
69 still very much under development, so please take care when trying
70 it out. In particular, Dasher will crash if you try to enable Kanji
71 conversion on a machine which does not have Japanese localisation
72 installed.
74 To use Kanji conversion in Dasher, you must select 'Japanese Canna'
75 from the 'Alphabet' section of the preferences dialogue, and the
76 Japanese language model from the 'Prediction' section.
78 Support and Feedback
79 --------------------
80 Please file any bug reports in the GNOME Bugzilla system:
82 http://bugzilla.gnome.org/
84 using the 'dasher' package name. We also appreciate general feedback -
85 please send any comments to 'dasher@mrao.cam.ac.uk'.
87 You can find the Dasher website at:
89   http://www.dasher.org.uk/
91 Thank you for trying Dasher,
93 The Dasher Team