Installation notes for SIOX - Gimp Plug-in
------------------------------------------

0.) System Requirements
1.) Installing Precompiled Plug-in
2.) Compiling from Source
2.1) Required Libraries
2.2) Compilation
2.3) Troubleshooting


0.) System Requirements
-----------------------

Theoretically, the plug-in should work on all platforms where GIMP 2.2 or higher runs. The provided binaries run under Linux (x86) and Windows XP systems. The plug-in was developed using SuSe 9.3. It was also tested on a Debian Sarge system. The plug-in was tested using GIMP 2.2.3, 2.2.4, and 2.2.8. Gimp 2.3.x may also work. GIMP 2.0 will not work. 

1.) Installing Precompiled Plug-in
---------------------------------

The easiest way to run SIOX is to use the precompiled binaries that can be found at http://www.siox.org. Copy the "siox4gimp" (Linux) or "siox4gimp.exe" (Windows) into the plug-in directory of your GIMP installation. The plug-in directory can be set in GIMP using the menu entry "File/Settings" and clicking on "Folders/Plug-Ins" in the appearing dialog. Please note, that under Linux GIMP plug-ins must be executable (chmod +x).

The next time you start GIMP, the plug-in should be available. For detailed instructions on using SIOX see the provided documentation in "README" and "http://www.siox.org". 

2.) Compiling from Source
-------------------------

We do not recommend compilation under Windows because setting up the appropriate compiling environment for GIMP plug-ins is a cumbersome task.
See "http://lists.xcf.berkeley.edu/lists/gimp-developer/2002-October/007494.html" for more information.

The following describes how to compile the "siox4gimp" plug-in on a Linux system.

2.1) Required Libraries
To compile the source code for a Linux system, you will need the following libraries (aside from the normal compilation tools such as gcc, awk, sed, etc...):
- gimp-2.2, developer version (http://www.gimp.org/unix/)
- gtk 2.6, glib-2.6.5, pango-1.8.1  (http://www.gtk.org/download/)

To install these packages, follow the instructions given on the web sites. These vary depending on what system you are using. Basically, you un-tar the library followed by the three-steps installation "configure, make, make install".   

2.2) Compilation
When all required libraries have been installed on your system, change to the "sources/" folder and type:

->./configure
->make
->make install

The binary is compiled into "src/siox4gimp" by "make" and copied into the GIMP plug-in folder by "make install". If the plug-in compiles correctly but "make install" complains, you are still able to install SIOX by copying it manually as described in Section 1. 

For further instructions on Gimp plug-ins see "http://docs.gimp.org/en/ch02s05.html" and "http://developer.gimp.org/".
