The speed spin button on the main screen now changes and is in synch
[dasher.git] / README
blob1816c1cdd3ebfd099e0a5f71da54997f634dfaf6
1 Dasher Version 4.10.0
2 --------------------
3 Dasher is a zooming predictive text entry system, designed for situations
4 where keyboard input is impractical (for instance, accessibility or PDAs). It
5 is usable with highly limited amounts of physical input while still allowing
6 high rates of text entry.
8 Dasher is Free software released under the GPL. Further documentation
9 may be found in the Doc/ subdirectory
11 Requirements
12 ------------
13 Dasher makes use of the following third party software (note that this
14 list is potentially inaccurate or incomplete - please send any
15 corrections to 'dasherteam@yahoogroups.com):
17 General:
18  * The Expat XML parser (required)
20 Linux (see INSTALL.Linux for build time requirements):
21  * GTK+ (2.2 or greated) (required)
22  * GNOME (optional, but highly recommended)
23  * GNOME Speech (optional)
24  * Libcanna (optional, for Hiragana to Kanji conversion)
26 MS Windows:
27  * MS Speech API (optional)
28  * MS Table API (optional - required for tablet start/stop mode)
30 MS Windows CE:
31  * (not sure - if anyone knows then please fill this in)
33 Platform Specific Notes
34 -----------------------
35 * Solaris: Dasher has been tested on Solaris 10. You will need to
36 upgrade to gnome-doc-utils 0.3.2 to install the documentation, which
37 in turn will require libxml 2.6.12 and libxslt 1.1.8. These packages
38 are not required to run dasher once it is built.
40 There have been some issues with the gthread-2.0 pkgconfig file
41 including compiler flags which are not understood by the compiler. You
42 may need to shadow this file in another directory with these flags
43 removed.
45 Currently GNU make (gmake) must be used.
47 * Darwin / OS-X: The native UI in the macos directory is badly out of
48 date and will almost definitely require considerable effort to
49 build. We do not currently have the resources to maintain this port,
50 but if you are interested in contributing then let us know
51 (dasher@mrao.cam.ac.uk). The GTK2 front end should build on Darwin
52 with minimal changes, and with a recent enough version of GTK will not
53 require the X11 server.
55 Installation Instructions
56 -------------------------
57 Please see the file INSTALL.<platform> for details on how to build and
58 install Dasher from source on your host system.
60 Font Support
61 ------------
62 Dasher includes some alphabets which require fonts that you probably don't 
63 have installed; for example, for the International Phonetic Alphabet, Korean
64 and Hiragana (Japanese).  We aren't legally allowed to distribute a font for
65 the IPA, but you can download one yourself from:  
67    http://www.sil.org/computing/fonts/encore-ipa.html
69 Kanji Entry
70 -----------
72 As of Dasher 3.99.0, experimental support for Japanese Kanji entry
73 by Hiragana conversion. To build Dasher with this enabled on Linux,
74 you need the libcanna conversion library. You also need to be able to
75 access a canna conversion server, which can be on the local machine or
76 over a network. Please note that Dasher will not start a canna server
77 if none is running - you must do so manually before running Dasher. 
78 Please see the Canna documentation for more details.
80 Kanji conversion in Microsoft Windows is via the IME API, which is
81 part of Windows XP and Asian builds of earlier Windows
82 versions. Support for Kanji conversion in Dasher under Windows is
83 still very much under development, so please take care when trying
84 it out. In particular, Dasher will crash if you try to enable Kanji
85 conversion on a machine which does not have Japanese localisation
86 installed.
88 To use Kanji conversion in Dasher, you must select 'Japanese Canna'
89 from the 'Alphabet' section of the preferences dialogue, and the
90 Japanese language model from the 'Prediction' section.
92 Support and Feedback
93 --------------------
94 Please file any bug reports in the GNOME Bugzilla system:
96 http://bugzilla.gnome.org/
98 using the 'dasher' package name. We also appreciate general feedback -
99 please send any comments to 'dasher@mrao.cam.ac.uk'.
101 You can find the Dasher website at:
103   http://www.dasher.org.uk/
105 Thank you for trying Dasher,
107 The Dasher Team