Skip to content

Commit

Permalink
update README's and INSTALL
Browse files Browse the repository at this point in the history
  • Loading branch information
svigerske committed Mar 15, 2019
1 parent fbf4604 commit 863b9f0
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 97 deletions.
2 changes: 2 additions & 0 deletions INSTALL
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
The instructions here are somewhat outdated. See also README.md.

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
Expand Down
97 changes: 2 additions & 95 deletions Osi/README
Original file line number Diff line number Diff line change
@@ -1,95 +1,2 @@
OPEN SOLVER INTERFACE LIBRARY README
=============================

In this README,

1. 'coin-Osi' is the full path to the directory in which you have
dowloaded Osi.

2. 'build' is the full path to the directory used for the installation
of Osi. It might be coin-Osi or some other directory of your choosing.


OVERVIEW
========

Welcome to the COIN-OR Open Solver Interface Library (Osi). Osi is
distributed under the Eclipse Public License Version 1.0 and is freely
redistributable. All source code and documentation is copyright by
International Business Machines Corporation and (many) others. This README
file may be distributed freely.

The COIN-OR Open Solver Interface Library is a collection of solver
interfaces (SIs) that provide a common interface --- the OSI API --- for all
the supported solvers.

Each SI is in a separate directory. The authors of each SI are listed in the
AUTHORS file in the subdirectory. The names of maintainers and contributors
to the base OsiSolverInterface code are listed in the AUTHORS file in this
(Osi) directory. For more information, see the Osi Trac page (see below).


OSI TRAC PAGE
=============

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


INSTALLATION
============

If you have downloaded the Osi package in the local directory coin-Osi,
please see the INSTALL file in coin-Osi (the parent directory of this
directory, unless you've changed the default Coin package directory
structure) for instructions on how to install the entire package.

If you have obtained Osi by downloading some other package, Osi will be
installed as part of the installation of that package. See the INSTALL
file in the main directory of the package (again, the parent directory of this
directory).


SUPPORT
=======

1. Authors

See the AUTHORS file.

2. Project Managers

The main project managers are

Lou Hafer, [email protected]
Matt Saltzmann, [email protected]

Lots of others help out.

3. Mailing List

Casual discussion of Osi can usually be found in the coin-discuss mailing
list. Serious discussion occurs in the coin-osi-devel mailing list. To
subscribe to either, go to http://list.coin-or.org/mailman/listinfo and
follow the links.

4. Bug Reports

Bug reports should be reported by creating a ticket at
https://projects.coin-or.org/Osi/newticket

You will need to create a login id. We apologise for the hassle, but it's
the only way to avoid spammers. The more you can tell us about the bug
(version of Osi, compiler version, operating system, etc.) the better the
chance that we can duplicate your bug and fix it. It's helpful if you
leave a valid email address, in case we need to contact you for more
information.

You can also report bugs on the mailing lists, but you're at the mercy of
the memory of the developers. Once that email gets filed, well, out of
sight, out of mind.

5. Requests for Enhancements

As for bugs, please create a ticket. Or, join the coin-osi-devel list and
lobby directly.

This is the Osi project. For information on the purpose of
this project please visit https://github.com/coin-or/Osi
3 changes: 1 addition & 2 deletions README
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

To install this package, please look at the INSTALL file.
To install this package, please look at the INSTALL and README.md files.

This package contains several subdirectories corresponding to COIN-OR
projects (www.coin-or.org). The AUTHORS, LICENSE and README files in
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,19 @@ The following is a list of derived Osi classes:
|[Vol](https://www.github.com/coin-or/Vol)|OsiVol| |
|[XPRESS-MP](https://www.fico.com/en/products/fico-xpress-optimization)|OsiXpr| |

Each solver interface is in a separate directory of Osi or distributed
with the solver itself.

Osi is written in C++ and is released as open source code under the [Eclipse Public License (EPL)](http://www.opensource.org/licenses/eclipse-1.0).
It is available from the [COIN-OR initiative](http://www.coin-or.org/).
Within COIN-OR, Osi is used by [Cgl](https://www.github.com/coin-or/Cgl), [Cbc](https://www.github.com/coin-or/Cbc), and [Bcp](https://www.github.com/coin-or/Bcp), among others.

The Osi website is https://github.com/coin-or/Osi.

The main project managers are Lou Hafer (@LouHafer) and Matt Saltzmann (mjsaltzman).

An incomplete list of recent changes to Osi are found in the [CHANGELOG](Osi/CHANGELOG)

## Getting Started using CoinBrew

To build CoinUtils from source, obtain the `coinbrew` script from
Expand Down

0 comments on commit 863b9f0

Please sign in to comment.