                                      Kisa
                      Pete Black <theblackpeter@gmail.com>

ABOUT
Kisa provides spell checking as you type under X11 desktops (such as KDE) and
displays the result in a small window on your. You can type anywhere, in any
window and Kisa will spell check the word for you. Kisa uses GNU Aspell as a
back-end, so it's relatively easy to manage and install more dictionaries as
needed.

By connecting to the current X server running your desktop, Kisa subscribes for
event notifications from windows that it thinks interesting. Kisa uses standard
X11 event subscriptions to handle these event notifications. For example,
whenever there is a keypress event in a window, Kisa will be notified if
subscribing for keypress events from that window. There is no logging or screen
capturing performed and Kisa adheres to standard X11 security principles.
However, remember that anything you type will potentially be displayed. So when
typing a password it may be shown in clear text.

What Kisa is not:
  * a thesaurus (at least not yet)
  * a word completer, type first 3 characters and get the full word
  * a keylogger
  * a way to save the world, unfortunately


LICENCE
Gnu General Public License (GPL) version 2, see COPYING file.


RUNTIME REQUIREMENTS
  * X11 (tested under X.org 7.2)
  * GNU Aspell spell-checker runtime library (debian package: libaspell15)
  * Qt 4 core GUI runtime library 4.3.2 or later (debian package: libqt4-gui)


COMPILE REQUIREMENTS
  * X11 client-side library development headers (debian package: libx11-dev)
  * GNU Aspell development libraries (debian package: libaspell-dev)
  * Qt 4 development files 4.3.2 or later (debian package: libqt4-dev)

PACKAGE INSTALLATION
Check your package manager documentation for details on how to install custom
packages.


INSTALLATION FROM SOURCE
Unpack kisa-0.43.tar.bz2 and from that folder do (make sure you use the Qt 4
version of qmake):
  qmake (1)(2)
  make
  sudo make install (3)


UNINSTALLATION FROM SOURCE
From the source folder do:
  sudo make uninstall (3)

(1) To install available translations files pass the desired language to qmake
in the LINGUAS variable:
  qmake LINGUAS="sv"

(2) For debug support do: (enable full debug output by setting FULL_DEBUG flag)
  qmake -config debug "DEFINES += FULL_DEBUG"

(3) Note: sudo might not be available to on your system. This step is only
necessary for installation or uninstallation, but requires root privileges. You
can run the application by executing the binary kisa in the resulting bin
folder.


HELP
Help yourself at http://kisaspellchecker.googlepages.com/manual or help me by
giving constructive criticism ;).


DISCLAIMER
THIS INFORMATION AND/OR SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS INFORMATION AND/OR
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
