gWaei README 
*******************************
Welcome to the README file.  This file is GPL licensed. If you plan on
redistributing this software you should read the COPYING file. For more help
than is written here, go to the projects webpage at
http://gwaei.sourceforge.net/



TABLE OF CONTENTS

  1.0 PREREQUISITES
  2.0 CONFIGURATION AND INSTALLATION
  3.0 COMPILING ON WINDOWS


1.0 PREREQUISITES:

  To run gWaei 3.2.x, an environment with at least gtk+-3.2.0/glib-2.30.0,
  curl 7.20.0, gnome-doc-utils-0.14.0, and gsettings-desktop-schemas are
  required. Additionally, you will want to have gunzip, enchant, and
  ttf-kanjistrokeorders available.

  An example of a command that Ubuntu/Debian users might use to get the
  required runtime dependancies is:

  sudo apt-get install libcurl4-gnutls libgtk-3 gnome-doc-utils \
  ttf-kanjistrokeorder enchant gsettings-desktop-schemas

  To compile the program, you will have to have the dev files for GTK+, CURL3,
  available. Users with binary based distributions should install the 
  approprate "dev" or "devel" files for the above dependencies using their
  package manager. Automake and GCC will come in handy too, as they are 
  standard build tools for GNU systems.

  An example of a command that Ubuntu/Debian users might use to get the
  required compilation dependancies is:

  sudo apt-get install libcurl4-gnutls-dev libgtk-3-dev gnome-doc-utils \
  libncursesw5-dev imagemagick intltool  rarian-compat \
  gsettings-desktop-schemas

  For inputing Japanese queries, installing some software for Japanese
  conversion is highly recommended.  Currently, the three main linux methods are
  UIM or SCIM using the ANTHY engine or iBus.  For emergency situations where users
  can't install either, gWaei has internal support for converting romanji
  searches to hiragana/katakana automatically.  (This conversion is disabled
  for Japanese locals by default in the preferences.)



2.0 CONFIGURATION AND INSTALLATION:

  When configuring, the most important variable for this program is the  
  prefix.  Most users will install using steps similar to below.

  2.2 CREATION OF MISSING FILES FOR A FRESH DOWNLOAD FROM THE GIT REPO
    $ ./autogen.sh

  2.3 BUILDING AND INSTALLING FROM THE SOURCE CODE:
    $ ./configure --prefix /usr 
    $ make
    $ sudo make install

  2.3 UNINSTALL:
    $ sudo make uninstall


3.0 COMPILING ON WINDOWS:

  gWaei has been tested and built on Windows with some success through MinGW.
  Since I do not have a Windows PC of my own handy, I only get to test and
  maintain builds sporadically through Wine.  Your success will largely depend
  on how well you have your MinGW environment set up.

  I currently test using MinGW cross compilation and Wine on Fedora.  You will have to
  install the correct MinGW packages through yum, and download a binary of gzip and
  the source to gnome-doc-utils manually.

  1. Install gnome-doc-utils using

       mingw32-configure
       mingw32-make
       sudo mingw32-make install

  2. Copy the contents of the gzip binary to the bin directory of your installation.  That would
  be /usr/i686-pc-mingw32/sys-root/mingw/bin/ for me.

  3. Build gwaei by doing
    
      mingw32-configure --disable-scrollkeeper
      mingw32-make
      sudo mingw32-make install


  The mingw32-configure script will take care of PKG_CONFIG_PATH and such for you.  You should in general compile any needed deps with --disable-scrollkeeper.


END