
Welcome to Ox, version 3.30
===========================

There are several types of installation
[A] CD-ROM installation
    - setup program for Windows XP/2000/NT/ME/98 (Professional version)
    - zip file installation for all other platforms (or copy from CD)
[B] Internet installation (from www.nuff.ox.ac.uk/users/doornik)
    - setup program for Windows XP/2000/NT/ME/98 (Console version)
    - setup program for Windows XP/2000/NT/ME/98 (Professional version)
      this requires a valid Ox Professional 3.x licence code
	- setup program for Linux (for Redhat package manager)
    - zip file installation for all other platforms
	  (for Windows and Linux it is recommended that you use the
	  automatic setup programs instead).


Internet installation: setup program for Windows XP/2000/NT/ME/98
-----------------------------------------------------------------
The setup program will NOT set OX3PATH and NOT update the path
statement. The former is not normally necessary because a default
is used. The latter can be done by the user if so desired.
*** If you have an old version of Ox, and install the new Ox
into another directory, you have to ensure that it is not the
old version which is run because of your PATH statement. ***
    

CD-ROM installation for Windows XP/2000/NT/ME/98
------------------------------------------------
Run the OxPro330.exe program from the root directory of the CD-ROM.
The setup program will NOT set OX3PATH and NOT update the path
statement. The former is not normally necessary because a default
is used. The latter can be done by the user if so desired.
*** If you have an old version of Ox, and install the new Ox
into another directory, you have to ensure that it is not the
old version which is run because of your PATH statement. ***


Some important notes:
---------------------
- Ox Professional works with GiveWin 2.
  A licensing code is required to use Ox with GiveWin. 
- If you alread have an old Ox installed, and install the new
  version in another folder, the old path must be removed from
  the PATH statement.
- The installation program may require write access to the Windows
  system directory (InstallShield will attempt to update the uninstall
  binary if it is old). If the installation fails, you can use the
  zipfile installation instead. 


Zip file installation
---------------------
NB: for Windows and Linux (Redhat) it is recommended that you use
the automatic setup programs instead.

There are four setup related files:
readox.txt   -- this file
readunix.txt -- Unix related installation notes.
unzip.exe    -- Info-ZIP's unzip program (Windows 95/NT)
setup.bat    -- setup batch file for Windows XP/2000/NT/ME/98

There are several .zip files:
oxbas330.zip  -- basic files: Ox header filess, source and samples,
                 HTML documentation
                 This file is required by all zip-file installations!
oxwin330.zip  -- Windows executables and libraries
oxdev330.zip  -- development kit, only required for writing DLLs to
                 extend Ox.

and for various other platforms:
oxlnx330.zip  -- Linux executables and libraries
oxosx330.zip  -- OS-X (Mac) executables and libraries
oxsun330.zip  -- Sun (Sun5) executables and libraries
oxdec310.zip  -- Dec-Unix executables and libraries
oxhp300.zip   -- HP-UX executables and libraries
oxsgi300.zip  -- SGI (Mips 2 and 4) executables and libraries
oxaix220.zip  -- IBM/AIX executables and libraries

So for Windows get at least:
    oxbas320.zip, oxwin320.zip, unzip.exe, setup.bat.
Put these files in a directory called Ox (for example
"\Program Files\ox"; or simply just in \ox).
Then run the relevant setup batch file.

The setup batch files do nothing more than unzipping the archives,
retaining the directory structure as stored in the archives.

It is recommended to install into a clean directory, because
the file layout has been restructured somewhat.

Ox is packaged using Info-ZIP's compression utility. The installation
uses UnZip to read the zip files.  Info-ZIP's software (Zip, UnZip and
related utilities) is free and can be obtained as source code or
executables from various bulletin board services and anonymous-ftp sites,
including CompuServe's IBMPRO forum and ftp.uu.net:/pub/archiving/zip/*.
The executable unzip files are also downloadable from my homepage.


Completing the basic installation
---------------------------------

To run Ox from other directories (assuming you installed on the C drive
in c:\ox), add:

    c:\ox\bin

to your PATH statement in the autoexec.bat file (under Windows XP/2000/NT
use the system icon in the control panel).
If this is set, you can run an Ox program called test.ox as
   oxl test
Otherwise you need to type:
   c:\ox\bin\oxl test


You do NOT need to add the line:

    set OX3PATH=c:\ox\include;c:\ox

because that is the default when the OX3PATH variable is not set.
However, if you have additional folders in which you want Ox to
search, you have to use the above statement with the additional
folders appended. 


Ox Professional
---------------
The components in the Windows version which enable using GiveWin 2
are part of the professional release.  See Availability in the
online Ox documentation. These components are primarily OxRun.exe,
OxDebug.exe and some DLLs (to interact with GiveWin), as well as
oxli.exe (the debug/interactive version).


Downloading
-----------
All the necessary files are available via
       http://www.nuff.ox.ac.uk/Users/Doornik/Index.html.


World Wide Web
--------------
For a list of known bugs, fixes and planned features, check:
       http://www.nuff.ox.ac.uk/Users/Doornik/index.html.
This page has pointers to relevant Ox information, and to the 
sites from which you can download Ox.
There is also the ox-users discussion list.


Documentation
-------------
Is supplied in HTML format for online browsing.


Getting started
---------------

Load \ox\doc\index.html in your Web browser.


Comments
--------
I would appreciate hearing any comments, criticisms, bug reports,
etc. you may have. Please send them to me.
    

Jurgen A Doornik, Nuffield College, jurgen.doornik@nuffield.ox.ac.uk


NO WARRANTY WHATSOEVER IS GIVEN FOR THESE PROGRAMS.
YOU USE THEM AT YOUR OWN RISK!
All company and product names referred to in this documentation
are either trademarks or registered trademarks of their associated
companies. 


---------------------------------------------------------------------

Registry
--------

The Console executables do not use the registry (they use
the OX3PATH environment variable).
OxRun and OxDebug automatically register themselves when run.

The entries in HKEY_CLASSES_ROOT are for file types:
    .ox        (points to OxFile entry)
    OxFile     (Ox source code files)
All persistent data is stored in HKEY_CURRENT_USER under
Software\GiveWin.


