
WHAT IS SUDOKUKI?

  Sudokuki is a graphical SUDOKU game.

  Sudokuki aims at being 'essential', meaning that it does what you'd expect
  from a sudoku game, and not much more.

  Features:
     - Generate a sudoku grid
     - Set-up a grid from a magazine or so
     - Play the grid:
        o Checking values entered by the user
        o Dead-end detection
        o Clear all moves
     - Save the game
     - Open a previously saved game
     - Helper feature: solve the SUDOKU grid
     - Helper feature: resolve a single cell
     - Export to HTML & Print the generated grid from your Web browser.

  Translations:
    At the moment, Sudokuki is available in the following languages:
     - English, Esperanto, French, German, Greek, Japanese, Spanish.
     - If you'd like to provide translations for your own language, please
       contact the author on the Sudokuki forums hosted by Sourceforge.   
  
  Freedom:
    Sudokuki is not only Open-Source, it is Free Software, 
    released under the GNU General Public License,
    which means you can download it, use it, and redistribute it, 
    as long as you respect the GPL license, intended to preserve 
    not only the author's rights but also the users' rights.

  Sudokuki is multiplatform GNU/GPL Free Software, written in C++.
  Have fun! 


RUNNING SUDOKUKI ON MS-WINDOWS

  ===============================================
  ==                                           ==
  ==    TO RUN SUDOKUKI ON MS-WINDOWS          ==
  ==    EITHER INSTALL GTK+ AND GTKMM          == 
  ==    OR USE THE 'FULL WIN32 PACKAGE'        ==
  ==    AVAILABLE ON SOURCEFORGE:              ==
  ==    http://sudokuki.sourceforge.net/       ==
  ==                                           ==
  ===============================================


INSTALLING SUDOKUKI ON GNU/LINUX AND MANY OTHER OPERATING SYSTEMS

    You need to install Gtkmm (C++ wrapper to Gtk+) before installing Sudokuki.
    For instance, if you are using Debian GNU/Linux:
      % apt-get update
      % apt-cache search gtkmm    (to find the exact name of the gtkmm package)
      # apt-get install libgtkmm-2.4-dev    (to be able to compile sudokuki)
      # apt-get install libgtkmm-2.4-1c2a    (to be able to run sudokuki) 


    Install Sudokuki from source code:

    First, download the latest archive of Sudokuki (.tar.gz or .tar.bz2 archive), 
    for example, sudokuki_0_9_XX.tar.gz:

      % tar zxvf sudokuki_0_9_XX.tar.gz    (or % tar jxvf sudokuki_0_9_XX.tar.bz2)
      % cd sudokuki_0_9_XX/
      % ./configure    (to prepare for build on your platform)
      % make    (to build)
      % su    (to log in as superuser 'su')
      # make install    (as superuser 'su')
      # exit    (to close the 'su' session)
      % sudokuki    (to finally run sudokuki)


INSTALLING SUDOKUKI ON MS-WINDOWS, ETC.

  1) Install GTK+ Runtime Environment: 
   
    o For MS-Windows, install GTK+/Win32 Runtime Environment.
      You can download it from here:

      http://sourceforge.net/project/showfiles.php?group_id=121075

    o For MacOS X, install GTK+/MacOSX:

      http://developer.imendio.com/projects/gtk-macosx


  2) Install GTKmm/Win32 Runtime Environment:

    o For MS-Windows, install GTKmm/Win32 Runtime Environment:

      http://ftp.gnome.org/pub/gnome/binaries/win32/gtkmm/2.10/
      Install gtkmm-win32-runtime-2.10.8-1.exe, or the latest version.

    o For MacOS X, install Gtkmm:

      http://gtkmm.darwinports.com/


  3) Run Sudokuki:

    o Precompiled Sudokuki executables can be found here:

      https://sourceforge.net/projects/sudokuki/

    o However, if there is no recent executable available, 
      then you might have to build Sudokuki from source,
      in order to have the latest features, 
      bug fixes and optimisations of Sudokuki.


INSTRUCTIONS FOR DEVELOPPERS, ON MS-WINDOWS

    If you want to compile and link Sudokuki yourself (from the source code), 
    you can install Dev-C++ (for instance), from here:
    http://www.bloodshed.net/devcpp.html

    Then follow these steps:
      (a) install GTK+ Development Environment, 
      (b) install GTKmm Development Environment,
      (c) configure Dev-C++ for GTK+ and GTKmm,
      (c') alternatively you can use MinGW/Cygwin or MinGW/MSys
      (c") or you can cross-build Sudokuki for MS-Windows from GNU/Linux
      (d) build Sudokuki.

    Alternatively, you can use Eclipse or other development environments.


SUDOKUKI SOURCE CODE SVN CHECK-OUT

   You can check out Sudokuki's source code (SVN trunk) this way:

   % svn co https://sudokuki.svn.sourceforge.net/svnroot/sudokuki/trunk


CROSS-BUILDING SUDOKUKI FOR MS-WINDOWS FROM YOUR GNU/LINUX SYSTEM

   If you want to build Sudokuki on your GNU/Linux system 
   to make it available to MS-Windows users, here's how to do:
   
     o Install mingw32, for instance on Lenny(testing) Debian GNU/Linux:
         % apt-get install mingw32 mingw32-binutils mingw32-runtime 
       And then this command should be accessible:
         % i586-mingw32msvc-g++ --help

     o Download the latest gtk28-YYMMDD.7z and check instructions 
       from this external site (Inkscape project):
       http://inkscape.modevia.com/win32_inkscape_org/win32buildnotes.html
       Unzip the .7z archive using this command (7zip): 
         % 7za x gtk28-YYMMDD.7z

       Personnaly, I installed the gtk28 win32-runtime under ~/gtk28/

     o Now, extract Sudokuki's archive:
       - 1st example, sudokuki-0.9.0_gtkmm.tar.bz2:
         % tar jxvf sudokuki-0.9.0_gtkmm.tar.bz2
       - 2nd example, sudokuki-0.9.0_gtkmm.tar.gz:
         % tar zxvf sudokuki-0.9.0_gtkmm.tar.gz

     o Configure and build (see the alternative one-line command further below):
         % cd sudokuki
         % export CXXFLAGS="-mwindows -I/target/include/" ('-mwindows' avoids the 'cmd' window at runtime)
         % ./configure --host=i586-mingw32msvc
         % make

     o Instead, for setting-up PKG_CONFIG_PATH, CXXFLAGS, and building in one go,
       you can use a one-line command such as:

       (N.B: on my system, the gtk28 win32-runtime is under ~/gtk28/)

      PKG_CONFIG_PATH=~/gtk28/lib/pkgconfig/ CFLAGS="-D__SUDOKUKI_WIN32__" \
        CXXFLAGS="-D__SUDOKUKI_WIN32__ -mms-bitfields \
        -mwindows -I/target/include/" \
        ./configure --host=i586-mingw32msvc && make

       sudokuki.exe is now ready to use on MS-Windows.

     o In order to reduce the size of the resulting executable:
         % cd src/gtkmm
         % i586-mingw32msvc-strip sudokuki.exe (reduces the size of the .exe)


FEEDBACK

   Please let me now if Sudokuki works as well on your system as it does 
   on my Debian GNU/Linux... Otherwise, you're invited to file a bug report 
   if you encounter problems with Sudokuki or if you don't like the way it is.
   Thanks in advance.
               
   Don't hesitate to make comments and suggestions on the Sudokuki website,
   hosted by Sourceforge!

