Skip to content

Commit

Permalink
Re-generating README
Browse files Browse the repository at this point in the history
  • Loading branch information
tkralphs committed Jan 10, 2022
1 parent 5fe8210 commit 73a02b5
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ The Cbc development site is https://github.com/coin-or/Cbc.

## CITE

[![DOI](https://zenodo.org/badge/173509563.svg)](https://zenodo.org/badge/latestdoi/173509563)
Code: [![DOI](https://zenodo.org/badge/173509563.svg)](https://zenodo.org/badge/latestdoi/173509563)


## CURRENT BUILD STATUS

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

## DOWNLOAD

What follows is a quick start guide for obtaining or building
Cbc on common platforms. More detailed information is
available [here](https://coin-or.github.io/user_introduction.html).

### Docker image

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

Below is a quick start guide for building on common platforms. More detailed
build instructions are
[here](https://coin-or.github.io/user_introduction.html).
### Dependencies

Cbc has a number of dependencies, which are detailed in
[config.yml](.coin-or/config.yml). Dependencies on other COIN-OR projects are
automatically downloaded when obtaining the source with `coinbrew`. For some
of the remaining third-party dependencies, automatic download scripts and
build wrappers are provided (and will also be automatically run for required
and recommended dependencies), while other libraries that are aeasy to obtain
must be installed using an appropriate package manager (or may come with your
OS by default).

## BUILDING from source

The quick start assumes you are in a bash shell.

### Using `coinbrew`

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

## Project Links

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

0 comments on commit 73a02b5

Please sign in to comment.