$Id: s.COMPILE.win 1.1 01/03/02 23:03:19-00:00 neumann $
********************************
XOTcl Windows compilation guide:
********************************

- Consider to get a binary distribution of XOTcl from
   
    http://www.xotcl.org

- XOTcl is tested with the Cygwin B20 and the Visual CC Compiler.

Visual CC Compilation:
**********************

In order to compile with VCC the following steps have to be performed:

1) Get tcl/tk sources, compile tcl and/or tk, and install them properly.

2) Set to the PATH environment to the Tcl binary directory. E.g. in the 
   dos box you may write something like:
     SET PATH=c:\Progra~1\Tcl\bin;%PATH%
   where "c:\Progra~1\Tcl\bin" is the Tcl binary directory.

2) Untar the xotcl source and open the file "Makefile.vc" in the toplevel
   directory. Edit the first lines with the path
   information for your system, i.e., where to find tcl and tk sources
   and where to find the VCC compiler, and where tcl/tk binaries are 
   installed.

3) Then invoke: 

     nmake -f makefile.vc

   to compile xotcl.dll, xowish.exe, xotclsh.exe, XOTclSdbm, and Expat. 
   Moreover, package information and XOTcl documentation will be built.

4) Optionally, you may test the XOTcl build:

     nmake -f makefile.vc test

5) Now you can install XOTcl with:

     nmake -f makefile.vc install

Cywin Compilation:
******************

In order to compile with Cygwin the following steps have to be performed:

1) install cygwin properly and get at least the Tcl/Tk sources for
   cygwin and install them in the cygnus source tree. If you have changed 
   the original directory names, you habe to update the makefile.
 
2) open the cygwin bash window 

3) untar the xotcl-XXX.tar.gz as described in INSTALL. The Makefile assumes
   that you do this in the root directory of your harddisk, so that
   you get an /xotcl dir. Otherwise update the Makefile.

4) make XOTcl, e.g. by issuing:
   
     make
   
   or the one of the other make options, as described in INSTALL. 

5) install XOTcl, as described in INSTALL. Note, that the binaries 
   are installs in the Cygwin bin dir. Update your PATH variable if 
   you have not already. 

6) install packages (as described below)

XOTcl + Package Installation
****************************
Change to the root dir, e.g.:
  
  cd /xotcl

Now check where Tcl is installed and how the name of the tclsh***.exe
is. You have to invoke the installer with the Tcl dir as argument, e.g.
on my platform this is:

  tclsh8.3.exe installWin.tcl /Programme/Tcl

If you ommit the argument, like:

   tclsh80 installWin.tcl

the default "c:\Program~1\Tcl" directory is chosen, which should at least
work on English and German platforms (e.g. "Program Files", "Programme", ...)

Instead of tclsh**.exe you can also use the compiled xotclsh.exe for
installation -- use src/Release/xotclsh.exe.

Then you have to set the PATH to "c:\Program~1\Tcl\bin" and set the
TCLLIBPATH environment variable to where the xotcl/lib dir and the
packages are, like

  set TCLLIBPATH="/Program~1/Tcl/lib/xotcl"

now the packages are configured.

Testing Installation
********************

If your path variable for the tcl binaries (and the dlls) are set 
correctly, then you can test xotcl from the xotcl directory, with:

     xotclsh src/lib/testo.xotcl
     xotclsh src/lib/testx.xotcl
     xotclsh src/lib/speedtest.xotcl

These are two regression tests for basic and extended functionality.

If the TCLLIBPATH is set correctly you can run a test for the xml/rdf
suite:

     xotclsh packages/rdf/xoRDF.test

Good Luck! 

Please report bugs and problems to the authors under one of these
mail adresses:

  uwe.zdun@uni-essen.de
  gustaf.neumann@uni-essen.de
