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