Skip to content

Commit 70a00f5

Browse files
committed
Re-generating README
(cherry picked from commit b8035d8) Signed-off-by: Ted Ralphs <[email protected]>
1 parent ea60dc5 commit 70a00f5

File tree

2 files changed

+22
-7
lines changed

2 files changed

+22
-7
lines changed

.coin-or/generate_readme

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,12 @@ make_doxygen_info
106106
echo "## Project Links
107107
108108
Help:
109+
* [Code of Conduct](https://www.coin-or.org/code-of-conduct/)
109110
* [Discussion forum](https://github.com/coin-or/Clp/discussions)
110111
* [Report a bug](https://github.com/coin-or/Clp/issues/new)
111112
112113
Documentation:
113-
* [Doxygen-generated html documentation](http://www.coin-or.org/Doxygen/Clp)
114+
* [Doxygen-generated html documentation](https://coin-or.github.io/Clp/Doxygen)
114115
* Source code [examples](examples/)
115116
* [User's Guide](https://coin-or.github.io/Clp) (from 2004)
116117

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ The Clp development site is https://github.com/coin-or/Clp.
3434

3535
## CITE
3636

37-
[![DOI](https://zenodo.org/badge/173496299.svg)](https://zenodo.org/badge/latestdoi/173496299)
37+
Code: [![DOI](https://zenodo.org/badge/173496299.svg)](https://zenodo.org/badge/latestdoi/173496299)
38+
3839

3940
## CURRENT BUILD STATUS
4041

@@ -44,6 +45,10 @@ The Clp development site is https://github.com/coin-or/Clp.
4445

4546
## DOWNLOAD
4647

48+
What follows is a quick start guide for obtaining or building
49+
Clp on common platforms. More detailed information is
50+
available [here](https://coin-or.github.io/user_introduction.html).
51+
4752
### Docker image
4853

4954
There is a Docker image that provides Clp, as well as other projects
@@ -76,17 +81,25 @@ Source code can be obtained either by
7681
* Cloning this repository from [Github](https://github.com/coin-or/Clp) or
7782
* Using the [coinbrew](https://github.com/coin-or/coinbrew) script to get the project and all dependencies (recommended, see below).
7883

79-
Below is a quick start guide for building on common platforms. More detailed
80-
build instructions are
81-
[here](https://coin-or.github.io/user_introduction.html).
84+
### Dependencies
85+
86+
Clp has a number of dependencies, which are detailed in
87+
[config.yml](.coin-or/config.yml). Dependencies on other COIN-OR projects are
88+
automatically downloaded when obtaining the source with `coinbrew`. For some
89+
of the remaining third-party dependencies, automatic download scripts and
90+
build wrappers are provided (and will also be automatically run for required
91+
and recommended dependencies), while other libraries that are aeasy to obtain
92+
must be installed using an appropriate package manager (or may come with your
93+
OS by default).
8294

8395
## BUILDING from source
8496

8597
The quick start assumes you are in a bash shell.
8698

8799
### Using `coinbrew`
88100

89-
To build Clp from source, obtain the `coinbrew` script, do
101+
To download and build Clp from source, execute the
102+
following on the command line.
90103
```
91104
wget https://raw.githubusercontent.com/coin-or/coinbrew/master/coinbrew
92105
chmod u+x coinbrew
@@ -186,11 +199,12 @@ documentation [here](http://coin-or.github.io/Clp/Doxygen).
186199
## Project Links
187200

188201
Help:
202+
* [Code of Conduct](https://www.coin-or.org/code-of-conduct/)
189203
* [Discussion forum](https://github.com/coin-or/Clp/discussions)
190204
* [Report a bug](https://github.com/coin-or/Clp/issues/new)
191205

192206
Documentation:
193-
* [Doxygen-generated html documentation](http://www.coin-or.org/Doxygen/Clp)
207+
* [Doxygen-generated html documentation](https://coin-or.github.io/Clp/Doxygen)
194208
* Source code [examples](examples/)
195209
* [User's Guide](https://coin-or.github.io/Clp) (from 2004)
196210

0 commit comments

Comments
 (0)