Skip to content

Commit 73a02b5

Browse files
committed
Re-generating README
1 parent 5fe8210 commit 73a02b5

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ The Cbc development site is https://github.com/coin-or/Cbc.
6161

6262
## CITE
6363

64-
[![DOI](https://zenodo.org/badge/173509563.svg)](https://zenodo.org/badge/latestdoi/173509563)
64+
Code: [![DOI](https://zenodo.org/badge/173509563.svg)](https://zenodo.org/badge/latestdoi/173509563)
65+
6566

6667
## CURRENT BUILD STATUS
6768

@@ -71,6 +72,10 @@ The Cbc development site is https://github.com/coin-or/Cbc.
7172

7273
## DOWNLOAD
7374

75+
What follows is a quick start guide for obtaining or building
76+
Cbc on common platforms. More detailed information is
77+
available [here](https://coin-or.github.io/user_introduction.html).
78+
7479
### Docker image
7580

7681
There is a Docker image that provides Cbc, as well as other projects
@@ -103,21 +108,29 @@ Source code can be obtained either by
103108
* Cloning this repository from [Github](https://github.com/coin-or/Cbc) or
104109
* Using the [coinbrew](https://github.com/coin-or/coinbrew) script to get the project and all dependencies (recommended, see below).
105110

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

110122
## BUILDING from source
111123

112124
The quick start assumes you are in a bash shell.
113125

114126
### Using `coinbrew`
115127

116-
To build Cbc from source, obtain the `coinbrew` script, do
128+
To download and build Cbc from source, execute the
129+
following on the command line.
117130
```
118131
wget https://raw.githubusercontent.com/coin-or/coinbrew/master/coinbrew
119132
chmod u+x coinbrew
120-
./coinbrew fetch Cbc@stable/2.10
133+
./coinbrew fetch [email protected]
121134
./coinbrew build Cbc
122135
```
123136
For more detailed instructions on coinbrew, see https://coin-or.github.io/coinbrew.
@@ -211,7 +224,8 @@ documentation [here](http://coin-or.github.io/Cbc/Doxygen).
211224

212225
## Project Links
213226

214-
* [COIN-OR Initiative](http://www.coin-or.org/)
227+
* [Code of Conduct](https://www.coin-or.org/code-of-conduct/)
228+
* [COIN-OR Web Site](http://www.coin-or.org/)
215229
* [Discussion formum](https://github.com/coin-or/Cbc/discussions)
216230
* [Report a bug](https://github.com/coin-or/Cbc/issues/new)
217231
* [Doxygen-generated html documentation](http://coin-or.github.io/Cbc/Doxygen)

0 commit comments

Comments
 (0)