Skip to content

Commit 0efb7d4

Browse files
committed
Updating README script and re-generating README
1 parent 31864f4 commit 0efb7d4

File tree

2 files changed

+26
-11
lines changed

2 files changed

+26
-11
lines changed

.coin-or/generate_readme

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,12 @@ make_doxygen_info
6666

6767
echo "## Project Links
6868
69-
* [COIN-OR Initiative](http://www.coin-or.org/)
69+
* [Code of Conduct](https://www.coin-or.org/code-of-conduct/)
70+
* [COIN-OR Web Site](http://www.coin-or.org/)
7071
* [Discussion forum](https://github.com/coin-or/Osi/discussions)
7172
* [Report a bug](https://github.com/coin-or/Osi/issues/new)
72-
* [Doxygen-generated html documentation](http://www.coin-or.org/Doxygen/Osi/hierarchy.html)
73-
* [OSI2 Discussion](https://projects.coin-or.org/Osi2/wiki/Osi2Discussion)
73+
* [Doxygen-generated html documentation](https://coin-or.github.io/Osi/Doxygen)
74+
* [OSI2 Discussion](https://github.com/coin-or/Osi2/discussions)
7475
* The most recent tutorial on OSI can be accessed from the [page on presentations from the 2004 CORS/INFORMS Joint Meeting in Banff](http://www.coin-or.org/Presentations/CORSINFORMSWorkshop04/index.html).
7576
* [The COIN-OR Open Solver Interface: Technology Overview](http://www.coin-or.org/Presentations/CORS2004-OSI.pdf): An overview of the COIN-OR OSI and design issues for a next-generation version given at CORS/INFORMS 2004 by Matthew Saltzman.
7677

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ The Osi development site is https://github.com/coin-or/Osi.
5757

5858
## CITE
5959

60-
[![DOI](https://zenodo.org/badge/173476455.svg)](https://zenodo.org/badge/latestdoi/173476455)
60+
Code: [![DOI](https://zenodo.org/badge/173476455.svg)](https://zenodo.org/badge/latestdoi/173476455)
61+
6162

6263
## CURRENT BUILD STATUS
6364

@@ -67,6 +68,10 @@ The Osi development site is https://github.com/coin-or/Osi.
6768

6869
## DOWNLOAD
6970

71+
What follows is a quick start guide for obtaining or building
72+
Osi on common platforms. More detailed information is
73+
available [here](https://coin-or.github.io/user_introduction.html).
74+
7075
### Docker image
7176

7277
There is a Docker image that provides Osi, as well as other projects
@@ -99,17 +104,25 @@ Source code can be obtained either by
99104
* Cloning this repository from [Github](https://github.com/coin-or/Osi) or
100105
* Using the [coinbrew](https://github.com/coin-or/coinbrew) script to get the project and all dependencies (recommended, see below).
101106

102-
Below is a quick start guide for building on common platforms. More detailed
103-
build instructions are
104-
[here](https://coin-or.github.io/user_introduction.html).
107+
### Dependencies
108+
109+
Osi has a number of dependencies, which are detailed in
110+
[config.yml](.coin-or/config.yml). Dependencies on other COIN-OR projects are
111+
automatically downloaded when obtaining the source with `coinbrew`. For some
112+
of the remaining third-party dependencies, automatic download scripts and
113+
build wrappers are provided (and will also be automatically run for required
114+
and recommended dependencies), while other libraries that are aeasy to obtain
115+
must be installed using an appropriate package manager (or may come with your
116+
OS by default).
105117

106118
## BUILDING from source
107119

108120
The quick start assumes you are in a bash shell.
109121

110122
### Using `coinbrew`
111123

112-
To build Osi from source, obtain the `coinbrew` script, do
124+
To download and build Osi from source, execute the
125+
following on the command line.
113126
```
114127
wget https://raw.githubusercontent.com/coin-or/coinbrew/master/coinbrew
115128
chmod u+x coinbrew
@@ -147,11 +160,12 @@ documentation [here](http://coin-or.github.io/Osi/Doxygen).
147160

148161
## Project Links
149162

150-
* [COIN-OR Initiative](http://www.coin-or.org/)
163+
* [Code of Conduct](https://www.coin-or.org/code-of-conduct/)
164+
* [COIN-OR Web Site](http://www.coin-or.org/)
151165
* [Discussion forum](https://github.com/coin-or/Osi/discussions)
152166
* [Report a bug](https://github.com/coin-or/Osi/issues/new)
153-
* [Doxygen-generated html documentation](http://www.coin-or.org/Doxygen/Osi/hierarchy.html)
154-
* [OSI2 Discussion](https://projects.coin-or.org/Osi2/wiki/Osi2Discussion)
167+
* [Doxygen-generated html documentation](https://coin-or.github.io/Osi/Doxygen)
168+
* [OSI2 Discussion](https://github.com/coin-or/Osi2/discussions)
155169
* The most recent tutorial on OSI can be accessed from the [page on presentations from the 2004 CORS/INFORMS Joint Meeting in Banff](http://www.coin-or.org/Presentations/CORSINFORMSWorkshop04/index.html).
156170
* [The COIN-OR Open Solver Interface: Technology Overview](http://www.coin-or.org/Presentations/CORS2004-OSI.pdf): An overview of the COIN-OR OSI and design issues for a next-generation version given at CORS/INFORMS 2004 by Matthew Saltzman.
157171

0 commit comments

Comments
 (0)