third_party/hunspell/README.myspell

   1 MySpell is a simple spell checker that uses affix
   2 compression and is modelled after the spell checker
   3 ispell.
   4
   5 MySpell was written to explore how affix compression
   6 can be implemented.
   7
   8 The Main features of MySpell are:
   9
  10 1. written in C++ to make it easier to interface with
  11    Pspell, OpenOffice, AbiWord, etc
  12
  13 2. it is stateless, uses no static variables and
  14    should be completely reentrant with almost no
  15    ifdefs
  16
  17 3. it tries to be as compatible with ispell to
  18    the extent it can.  It can read slightly modified
  19    versions of munched ispell dictionaries (and it
  20    comes with a munched english wordlist borrowed from
  21    Kevin Atkinson's excellent Aspell.
  22
  23 4. it uses a heavily modified aff file format that
  24    can be derived from ispell aff files but uses
  25    the iso-8859-X character sets only
  26
  27 5. it is simple with *lots* of comments that
  28    describes how the affixes are stored
  29    and tested for (based on the approach used by
  30    ispell).
  31
  32 6. it supports improved suggestions with replacement
  33    tables and ngram-scoring based mechanisms in addition
  34    to the main suggestion mechanisms
  35
  36 7. like ispell it has a BSD license (and  no
  37    advertising clause)
  38
  39 But ... it has *no* support for adding words
  40 to a personal dictionary, *no* support for converting
  41 between various text encodings, and *no* command line
  42 interface (it is purely meant to be a library).
  43
  44 It can not (in any way) replace all of the functionality
  45 of ispell or aspell/pspell.  It is meant as a learning
  46 tool for understanding affix compression and for
  47 being used by front ends like OpenOffice, Abiword, etc.
  48
  49 MySpell has been tested under Linux and Solaris
  50 and has the world's simplest Makefile and no
  51 configure support.
  52
  53 It does come with a simple example program that
  54 spell checks some words and returns suggestions.
  55
  56 To build a static library and an example
  57 program under Linux simply type:
  58
  59 tar -zxvf myspell.tar.gz
  60 cd myspell2
  61 make
  62
  63 To run the example program:
  64 ./example ./en_US.aff ./en_US.dic checkme.lst
  65
  66 Please play around with it and let me know
  67 what you think.
  68
  69 Please see the file CONTRIBUTORS for more info.