These instructions are for UNIX-like systems (including Linux, Cygwin
and MSys) only.  If Microsoft Developer Studio projects are
maintained for this package, you can find instructions at

  https://projects.coin-or.org/MSVisualStudio

**********************************************************************
***                         DOWNLOAD                               ***
**********************************************************************

You can obtain the source code for the OS package in two ways:

1. Obtain the source directly from the COIN-OR subversion repository
   (recommended).  For this you needs the program 'svn' installed on
   your machine, and output of "svn --version" must contain 
   "handles 'https' scheme".

   Assuming that you want to download the code into a subdirectory
   "COIN-OS", you type

   svn co https://projects.coin-or.org/svn/OS/trunk Coin-OS

2. Download the tarball from http://www.coin-or.org/Tarballs/OS and
   extract it, for example, with

   gunzip OS_2006Jun07.tgz
   tar xvf OS_2006Jun07.tar

   (Here "2006Jun07" is of course replaced by the string in the
   tarball you downloaded.)

   More detailed download instructions can be found at

   https://projects.coin-or.org/BuildTools/wiki/user-download

**********************************************************************
***                        CONFIGURATION                           ***
**********************************************************************

Go into the directory that you just downloaded or extracted (e.g.,
Coin-OS or OS_2006Jun07).  Then you type

   ./configure

Note that you might have to specify additional options, in case you
don't want to use the default choices that configure makes (e.g.,
compilers).  Please visit

   https://projects.coin-or.org/BuildTools/wiki/user-configure

and the OS Trac page

   https://projects.coin-or.org/OS

for more information.

If everything went fine, you will see at the end of the output

   "Main configuration of OS successful"

**********************************************************************
***                COMPILATION AND INSTALLATION                    ***
**********************************************************************

In the directory where you ran the configure script:

1. Compile the code by typing

   make

2. To test if the code works, you can type

   make test

3. To install the code, you type

   make install

   After this, you will find the executables, libraries and header
   files in the "bin", "lib" and "include" subdirectory, respectively.

More information on the compilation and installation can be found at

   https://projects.coin-or.org/BuildTools/wiki/user-compile

**********************************************************************
***                     USING THE LIBRARIES                        ***
**********************************************************************

Now you can link your own code with the installed libraries.  You can
find examples in the

   OS/examples/

subdirectory, see also the information at

   https://projects.coin-or.org/BuildTools/wiki/user-examples



==== 8< ======================================================

From here on you find the original installation instructions for the
previous GNU Makefile build system.  Most details have changed, but
for now we keep it here so that possibly missing items might be found
here.

Prerequisites for installation:
- at the moment on (*)nix platforms you must use g++ 2.95.2 or higher.
- must use gnu make
- to make the documentation doxygen must be installed

Targets are put in subdirectories, whose name is derived from the
platform name (as returned by `uname`) and the optimization level
(e.g., Linux-g).

To build Osi library and unitTest
  - read and edit the top of Makefile to select
      - whether shared or static library should be built
      - optimization level
      - where the compiled library should be installed
        If you want to use the Volume Algorithm as a solver then first
        you must build and install libvol. See Vol/INSTALL in the COIN
        root directory.
  - read and edit ../Makefiles/Makefile.locations to uncomment Clp lines
  - 'make' to build and install the library.
  - 'make unitTest' to create the unitTest program. It will be placed
    in the target subdirectory.

  - 'make doc' to create the html documentation of the classes in the
    library and place them in doc/html.

To run Osi unitTest
  - unitTest from Osi directory

To build OS executable
  In This directory 'make unitTest'.  This actually creates and executable
    cbc in this directory which can both do unit test and act as simple
    driver.
  OS is fairly complex in that it needs:
    Cbc, Clp, Coin, Osi and Cgl

  It has been slightly tested with Osl instead of Clp.  It worked but
	more slowly as it was harder to give hints to OSL or switch off
	output etc.

Samples/sample2.cpp is preferred driver

For more information see README and files in Samples

