HHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH

                        Haskell 8-Puzzle

HHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH

Author:
 Carlos Colmenares
Universidad Simón Bolívar. 
Caracas, Venezuela.
HHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH

% This README file was last updated Jun 2010.


README FILE
-----------
SUMMARY:

(I)     Tech Specs
(II)    Compiling
(III)   Testing the game
(IV)    Further Information

HHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH

---------------------------------------------------------------------
(I) Tech Specs
---------------------------------------------------------------------

    The project was developed using the next tools, for effectively
compiling and runing the project it's needed to have the same versions
of the software mencioned here or other versions that are compatibles
whit the ones listed.

- The Glorious Glasgow Haskell Compilation System, version 6.12.1
- HGL-3.2.0.2 (*)
- pure-priority-queue-0.14 (**)
- GNU Make 3.81
- hmake 3.14
- Haddock version 2.6.0, (c) Simon Marlow 2006

(*) You can get this package in this web-site:
    http://haskell.cs.yale.edu/graphics/

(**) You can find this library in the 'lib' directory of the haskell
    8puzzle. For knowing how to install it, follow this link:

http://www.haskell.org/haskellwiki/Cabal/How_to_install_a_Cabal_package

---------------------------------------------------------------------
(II) Compiling the 8-Puzzle
---------------------------------------------------------------------

0.- Unzip all the files in any directory "alpha" (Quotes for clarity,
    the directory may have any arbitrary name).
    It's necessary for the active user to have read, write and
    execute permissions on "alpha".
    E.G.:

    > cd /tmp
    > tar -xzvf h8puzzle.tar.gz

1.- Go inside "alpha" directory and execute the make file:
    E.G.:

    > cd /tmp/h8puzzle
    > make

    Then the haskell 8-puzzle will be automatically compiled.

2.- For having the documentation of the haskell 8-puzzle, once in
    the "alpha" directory, type the comand:

    > make doc

    The documentation will be written to the "doc" directory
    in .html

---------------------------------------------------------------------
(III) Testing the game
---------------------------------------------------------------------

0.- For testing the game, change to the root directory of the haskell
    8 puzzle and run the executable "haskell-8puzzle". Actually, this
    executable is a simbolic link to the executable file "bin/Main".
    E.G.:

    > cd /tmp/h8puzzle
    > ./haskell-8puzzle 

    For playing, you need to interact with the interface trough
    the next keys:

    (w) Shifts the token that's under the empty cell Up
    (a) Shifts the token that's at the right the empty cell Left
    (s) Shifts the token that's over the empty cell Down
    (d) Shifts the token that's at the left the empty cell Right
    (q) Quit the game
    (r) Randomize the board; Make 100 random moves on the board
    (e) Find the optimal solution to the 8puzzle, show it and
        apply it to the board

---------------------------------------------------------------------
(IV) Further Information
---------------------------------------------------------------------

    If you are interested in the 8Puzzle or simply want to know any
information about it's creator, feel free to send an email to
the following email address:

> carlos.a.colmenares.r@gmail.com