See docs/LICENSE for The Xindice License

Before you can run or build Xindice on windows you need to obtain the following
programs and install them.

   - A copy of Sun's Java SDK version 1.3 or higher.

Running the server - Xindice Version 1.0 Windows

1. Unzip the Xindice distribution to c:\Xindice or c:\work\Xindice.

2. Make sure the jdk bin directory is in your PATH

3. Add the Xindice bin directory to your path. If you unzipped to
   c:\Xindice this will be c:\Xindice\bin

4. Set the JAVA_HOME environment variable to point to the location where the
   jdk was installed.

5. Set the XINDICE_HOME environment variable to point to the location where
   Xindice is installed.

6. Add the Xindice.jar file to your CLASSPATH
   (Either c:\Xindice\java\lib\Xindice.jar or
   c:\work\Xindice\java\lib\Xindice.jar)
   and make sure you have . in your CLASSPATH.

7. To start the server, cd to the base of the Xindice tree c:\Xindice if that
   is where you installed it and run.

   Type:
      startup

8. If all went well you should now have a running copy of Xindice. If you
    encountered any problems double check all the steps especially the setting
    of the environment variables.

9.  Run the API example (optional)

   Type
     cd %XINDICE_HOME\java\examples\api
     run org.Xindice.examples.APIExample

10. The server and documentation can be accessed using a web browser pointed to
    http://localhost:4080/


Compiling the server - Xindice Version 1.0 Windows

Note: if you have a pre-built download you can safely ignore this section, it
is primarily intended for developers wishing to make changes to the core
server.

1. Unzip/Checkout the Xindice source to c:\Xindice , c:\work\Xindice, or an
s   alternative location.

2. Make sure the jdk bin directory is in your PATH

3. Add the Xindice bin directory to your path. If you checked out to
   c:\Xindice this will be c:\Xindice\bin

4. Set the JAVA_HOME environment variable to point to the location where
   the jdk was installed.

5. Set the XINDICE_HOME environment variable to pont to the location where
   Xindice is installed.

6. If you're planning to build the examples you should go ahead and add the
   Xindice.jar file to your CLASSPATH. This file doesn't exist yet but it will
   once you build the server. If you checked out to c:\Xindice the file
   will be placed in c:\Xindice\java\lib\Xindice.jar. You should also make
   sure you have . in your CLASSPATH.

7. From a command prompt change directory to the base of the Xindice source
   tree then to the java directory.

   Type:
      cd %XINDICE_HOME%

8. Type "ant" without the quotes. If all is correct the server should build
   without error.  If you wish to have the API documentation available from
   the server then type "ant javadoc"

   Type:
      ant
      
9. You should now have a compiled server. To start the server you should cd to
   the base of the Xindice tree c:\Xindice if that is where you checked it
   out and run.

   Type:
      startup

10. If all went well you should now have a running copy of Xindice. If you
   encountered any problems double check all the steps especially the setting
   of the environment variables. The server can be accessed using a web browser
   pointed to http://localhost:4080/

11. Build the examples. (optional)

   Type
      cd %XINDICE_HOME%
      ant examples

   Each example directory has a README file that explains how to run it.

12.  Run the API example (optional)

   Type
     cd %XINDICE_HOME%\java\examples\api
     run org.apache.xindice.examples.APIExample

13. The server and documentation can be accessed using a web browser pointed to
    http://localhost:4080/

Note to developers: This process is a little too complicated and not very
flexible. Most of our development work is done on Linux so we would really
love for someone a little more savy with batch scripting to simplify this
process and remove things like the checkout path restriction.