Adding missing files
[dasher.git] / README
blob383a8253c28c30c6d669cdeb2f90bc0c36f97462
1 Dasher version 3.99.3 (4.0 preview 4)
2 ------------------------------------- 
4 This is Dasher 3.99.3, the fourth preview release of the upcoming 4.0
5 series. This version is `feature frozen' for 4.0, but it is still to
6 some extent development code, and should therefore be considered
7 potentially unstable. The full 4.0 release will coincide with the
8 release of GNOME 2.14, with another 3.99 being produced for the GNOME
9 beta 2. See:
11 http://live.gnome.org/TwoPointThirteen
13 for details of the release schedule.
15 Dasher is a zooming predictive text entry system, designed for situations
16 where keyboard input is impractical (for instance, accessibility or PDAs). It
17 is usable with highly limited amounts of physical input while still allowing
18 high rates of text entry.
20 Dasher is Free software released under the GPL. Further documentation
21 may be found in the Doc/ subdirectory
23 New Features In 3.99.3
24 ----------------------
25  * Bugfix - missing Win32 source files in archive
27 New Features In 3.99.2
28 ----------------------
29  * Improved button mode support
30  * Cairo support ported from 3.2 branch
31  * Win32 should build from tarball again
32  * Bugfixes
34 Requirements
35 ------------
36 Dasher makes use of the following third party software (note that this
37 list is potentially inaccurate or incomplete - please send any
38 corrections to 'dasher@mrao.cam.ac.uk'):
40 General:
41  * The Expat XML parser (required)
43 Linux:
44  * Autotools (required, build only)
45  * Intltool (required, build only)
46  * Libtool (required, build only)
47  * GTK+ (2.2 or greated) (required)
48  * GNOME (optional, but highly recommended)
49  * GNOME Speech (optional)
50  * Libcanna (optional, for Hiragana to Kanji conversion)
52 MS Windows:
53  * MS Speech API (optional)
54  * MS Table API (optional - required for tablet start/stop mode)
56 MS Windows CE:
57  * (not sure - if anyone knows then please fill this in)
59 Known Issues
60 ------------
61  * Win32 probably doesn't build from the tarball - please use CVS.
62  * Button mode implementation is incomplete (not all modes present,
63    and limited UI support for configuration options)
65 Installation Instructions
66 -------------------------
67 Please see the file INSTALL.<platform> for details on how to build and
68 install Dasher from source on your host system.
70 Font Support
71 ------------
72 Dasher includes some alphabets which require fonts that you probably don't 
73 have installed; for example, for the International Phonetic Alphabet, Korean
74 and Hiragana (Japanese).  We aren't legally allowed to distribute a font for
75 the IPA, but you can download one yourself from:  
77    http://www.sil.org/computing/fonts/encore-ipa.html
79 Kanji Entry
80 -----------
82 Dasher 3.99.0 contains experimental support for Japanese Kanji entry
83 by Hiragana conversion. To build Dasher with this enabled on Linux,
84 you need the libcanna conversion library. You also need to be able to
85 access a canna conversion server, which can be on the local machine or
86 over a network. Please note that Dasher will not start a canna server
87 if none is running - you must do so manually before running Dasher. 
88 Please see the Canna documentation for more details.
90 Kanji conversion in Microsoft Windows is via the IME API, which is
91 part of Windows XP and Asian builds of earlier Windows
92 versions. Support for Kanji conversion in Dasher under Windows is
93 still very much under development, so please take care when trying
94 it out. In particular, Dasher will crash if you try to enable Kanji
95 conversion on a machine which does not have Japanese localisation
96 installed.
98 To use Kanji conversion in Dasher, you must select 'Hiragana ... (For
99 use with Hapanese language model)' from the 'Alphabet' section of the
100 preferences dialogue, and the Japanese language model from the
101 'Prediction' section.
103 Support and Feedback
104 --------------------
105 Please file any bug reports in the GNOME Bugzilla system:
107 http://bugzilla.gnome.org/
109 using the 'dasher' package name. We also appreciate general feedback -
110 please send any comments to 'dasher@mrao.cam.ac.uk'.
112 You can find the Dasher website at:
114   http://www.dasher.org.uk/
116 Thank you for trying Dasher,
118 The Dasher Team