***********************************************************

          TestU01: Testing Random Number Generators

***********************************************************

TestU01 is a package implemented in ANSI C. It is designed to make it
reasonably simple to perform statistical tests on arbitrary random
number generators (RNG).

It is copyrighted by Pierre L'Ecuyer.

e-mail:  lecuyer@iro.umontreal.ca
http://www.iro.umontreal.ca/~lecuyer/


---------------------------------------------------------------------------
DIRECTORY STRUCTURE

-- share/TestU01/examples:  program examples showing how to use TestU01.

-- share/TestU01/param:	 parameter files for family of generators (modules f*).

-- share/TestU01/doc: documentation in *.pdf

-- lib:  precompiled libraries

-- include: header files

-- bin


  
---------------------------------------------------------------------------
DOCUMENTATION

The main documentation of this package was written originally in
Latex format; it has been used to create doc in PDF format. 
There are files named guide....pdf containing the documentation on the 
modules in the original directory
and giving a description of the public variables and functions.
The *.pdf file may be viewed with a PDF reader like Acrobat.

There is a short and a long version of the user guide for original 
directory testu01 : guideshorttestu01.pdf and guidelongtestu01.pdf.
The short version may be sufficient for the typical user.
The longer version contains more details on functions and types and
their possible uses.


---------------------------------------------------------------------------
USAGE

If the installation process has worked without glitch, there will be a
subdirectory
   share/TestU01/examples
containing a few small example programs. In order to compile the small programs,
the 3 following paths must be added to the environment variables.

LD_LIBRARY_PATH    <install directory>/lib
LIBRARY_PATH       <install directory>/lib
C_INCLUDE_PATH     <install directory>/include

[ If the libraries have been installed in /usr/local, it may be
  necessary for some Unix/Linux systems to redefine these 3 paths.
  More specifically, the environment variables LD_LIBRARY_PATH and LIBRARY_PATH
  point to the /usr/local/lib (or /usr/local/lib64 for x86_64) directory. Use
     echo $LD_LIBRARY_PATH
     echo $LIBRARY_PATH
  to get the current library paths, and check that the appropriate directory is
  included. If it is not included, you need to redefine them as follows. ]

In a c-shell, they can be added or set with

   setenv LD_LIBRARY_PATH <install directory>/lib:${LD_LIBRARY_PATH}
   setenv LIBRARY_PATH <install directory>/lib:${LIBRARY_PATH}
   setenv C_INCLUDE_PATH <install directory>/include:${C_INCLUDE_PATH}

or perhaps simply

   setenv LD_LIBRARY_PATH <install directory>/lib
   setenv LIBRARY_PATH <install directory>/lib
   setenv C_INCLUDE_PATH <install directory>/include


In a Bourne shell, they can be added or set with

   export LD_LIBRARY_PATH=<install directory>/lib:${LD_LIBRARY_PATH}
   export LIBRARY_PATH=<install directory>/lib:${LIBRARY_PATH}
   export C_INCLUDE_PATH=<install directory>/include:${C_INCLUDE_PATH}

or perhaps simply

   export LD_LIBRARY_PATH=<install directory>/lib
   export LIBRARY_PATH=<install directory>/lib
   export C_INCLUDE_PATH=<install directory>/include


Then the small example birth1.c in directory examples can be compiled with
the C compiler

gcc birth1.c -o birth1 -ltestu01 -lprobdist -lmylib -lm


---------------- Note for Windows users -----------------
For MinGW, the user may have to compile-link as

gcc birth1.c -o birth1.exe -ltestu01 -lprobdist -lmylib -lwsock32

---------------------------------------------------------
For Cygwin, before running the program, the user may have to set

export PATH=<install directory>/bin:${PATH}

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