/**
@file README.TXT

@mainpage xComplete2

@section intro_sec Introduction

xComplete2 is an X11 client that watches what you type, politely
suggests completions, and then fills in the ends of long (>5
characters) words and variable names.  The current version number is
in src/version.hh, and recent changes can be seen in the file
RELEASE_NOTES.TXT.

@section contact_sec Contact

Bugfixes and patches welcome!  Please see the file LICENSE.TXT in
this directory for up-to-date contact information.

@section license_sec License

Please see the file LICENSE.TXT in this directory.

@section platform_sec Platform

This application has so far only been used under Debian GNU/Linux with
the Xorg X server.  The code should be pretty easy to port to other
X11-based systesms.  If you want to run this application with any
other windowing system, you'll have to create a subclass of
CompleterApp.  The best way to do this is by copying
CompleterAppX11.[cc/hh]

@section dependencies_sec Dependencies

To build xComplete2, you'll need the FLTK libraries from
http://www.fltk.org, and the boost::regex library from
http://www.boost.org.  We currently use fltk version 1.1.

@section installation_sec Installation

Building and installing is done via GNU Autotools.  If you're building
from a tarball, the simplest possible version looks like this:

@code
> tar -xvf xComplete2-x.y.tar.gz
> cd xComplete2-x.y
> ./configure
> make
> make install
@endcode

Of course, you may want to specify an installation directory, or make
other customizations to the installation.  You can find out about the
available configuration options by running

@code
> ./configure --help
@endcode

after you've untarred the tarball and cd'd to the newly created directory.

@section bugs_sec Bugs

  - xComplete2 doesn't work at all if Num-Lock is active.

  - KeyHistory gets confused if you type words which are longer than
    historySize, which currently defaults to 256 keystrokes.

  - If you mis-type a word, then type some whitespace, then backspace
    over the whitespace to correct the mis-typed word, the mis-typed
    word is not removed from the word history, although the corrected
    word will be added next time you type some whitespace.

**/