== Introduction ==

I've been playing around with Sikuli (http://sikuli.org/) as an option for some
automated GUI testing in Fedora. While the concept is really cool and the IDE
is pretty easy to use, the software doesn't appear to have been designed to be
built alongside anything else.

I spent a decent amount of time QnD hacking (and I do emphasize QnD) on the cmake
files so that I could get Sikuli to build and function on Fedora. I'm sure that
it could be coaxed into behaving better at some point, but I just wanted to
explore it a little before trying to undertake anything that huge.

While this isn't my favorite way to distribute software, it does work for the
time being.

I've been able to build and run Sikuli-1.0-RC3 using this setup on both F15 and
F16.

== Getting Started ==
Extract this tarball into somewhere under your home dir - I've had problems trying
to build it in /opt (I suspect SELinux but have't spent the time to actually 
figure it out). You will need to change the install dir in build_sikuli.sh in
order for this to work.

The two variables that will need to be changed are:
 * BASE_DIR - The directory that you have extracted everything into
 * BASE_DIR_SED - $BASE_DIR with its '/' escaped for sed

For example, if you extracted the tarball into /home/user/programs, the variables
would need to be set as:
BASE_DIR=/home/user/programs
BASE_DIR_SED=\/home\/user\/programs

== Dependencies ==
Since we're building Sikuli and all of its direct dependencies from scratch,
there are a lot of required dependencies. There are probably one or two in this
list that aren't strictly required but this whole distribution and setup method
is uber QnD, anyways. To install with yum, run:

yum install libtool chrpath f2c eigen2-devel imlib2-devel libucil-devel \
libtheora-devel libvorbis-devel libraw1394-devel libdc1394-devel libv4l-devel \
OpenEXR-devel tbb-devel python-devel swig gstreamer-devel gstreamer-plugins-base-devel \
cmake gtk2-devel jasper-devel lapack-devel libjpeg-devel libtiff-devel numpy \
gcc make gcc-c++ java-1.6.0-openjdk-devel

== Building ==
Run:
  sh build_sikuli.sh

Assuming that all the build dependencies were installed, you should have a
functional build of Sikuli now.

== Running ==
Sikuli will have been installed to:
  $BASE_DIR/Sikuli-1.0-RC3/Sikuli-IDE/target/linux/Sikuli-IDE

To run the Sikuli IDE, run the shell script in that dir:
  sh sikuli-ide.sh