Initial revision
[old-projects.git] / ekit / com / swabunga / README
1 \r
2                          J A Z Z Y : Java Spell Checker\r
3 \r
4 \r
5   What is it?\r
6   -----------\r
7 \r
8   Jazzy is a 100% pure Java library implementing a spell checking algorithm\r
9   similar to aspell. It may be used to spell check a variety of sources.\r
10 \r
11   The Latest Version\r
12   ------------------\r
13 \r
14   The latest version is available from the Jazzy project web site \r
15   (http://sourceforge.net/projects/jazzy).\r
16 \r
17   Requirements\r
18   ------------\r
19 \r
20   The following requirements exist for installing Jazzy:\r
21 \r
22    o  Java Interpreter:\r
23 \r
24       A fully compliant Java 1.1 Runtime environment is needed for the core engine of Jazzy \r
25       to operate. (For example: for use in a servlet)\r
26       \r
27       A fully compliant Java 1.3 Runtime environment is needed for the swing components of\r
28       Jazzy to operate.\r
29 \r
30    o  Java JFC (Swing components):\r
31 \r
32       These GUI extentions are required for proper GUI functionality. However, core \r
33       spell check functionality can work without Swing Components. \r
34 \r
35   Installation Instructions and Documentation\r
36   -------------------------------------------\r
37 \r
38   There are two ways to install Jazzy. One from a pre packaged version and the other is to \r
39   compile the sources from CVS.\r
40 \r
41   If you have downloaded the source code from CVS, please cd to the jazzy directory and run ant.\r
42 \r
43   Licensing and legal issues\r
44   --------------------------\r
45 \r
46   Jazzy is licensed under the LGPL. See LGPL.txt for license restrictions.\r
47 \r