gspell - a spell-checking library for GTK+ applications
=======================================================

This is version 0.2.4 of gspell.

gspell provides a flexible API to add spell checking to a GTK+ application.

Announcement and why this library has been created:

    https://blogs.gnome.org/swilmet/2015/09/16/introducing-gspell-a-new-spell-checking-library/

The gspell library is free software and is released under the terms of the GNU
LGPL version 2.1 or later. See the file 'COPYING' for more information.

The official web site is:

    https://wiki.gnome.org/Projects/gspell

You can download the latest gspell tarball from:

    https://download.gnome.org/sources/gspell/

Bugs and feature requests should be reported in bugzilla, but please search the
database before filing a new bug:

    https://bugzilla.gnome.org/page.cgi?id=browse.html&product=gspell


About versions
--------------

gspell follows the GNOME release schedule.

gspell 0.1.x should be installed alongside GNOME 3.18.

gspell 0.2.x versions correspond to GNOME 3.19 versions. The API can now be
considered stable and the 0.2 series will lead to the 1.0 version, which will
be released at the same time as GNOME 3.20 in March 2016.

Warning: the 1.0 version will *not* be completely parallel-installable with the
0.1 version, only the libtool version will be bumped. Using the 0.1 version is
highly discouraged.


Dependencies
------------

* GLib >= 2.44
* GTK+ >= 3.16
* Enchant >= 1.6.0
* iso-codes


Installation from a tarball
---------------------------

Simple install procedure:

  $ ./configure
  $ make
  [ Become root if necessary ]
  $ make install

See the file 'INSTALL' for more detailed information.


Installation from Git
---------------------

It is recommended to use Jhbuild:

    https://wiki.gnome.org/Projects/Jhbuild


How to contribute
-----------------

See the file 'HACKING'.
