Skip to content

Commit

Permalink
doc: Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Maroon502 committed Apr 11, 2024
1 parent df2d97d commit 37c1268
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,19 @@

[![Package][package-img]][package-url] [![Documentation][documentation-img]][documentation-url] [![License][license-img]][license-url]

coincbc-sys crate is a *-sys crate. The package provides Low-level bindings to the [Cbc] library.
`coincbc-sys` crate is a *-sys crate. The package provides Low-level bindings to the [Cbc] library.

By this package, you don't need to worry about installing Cbc in the system, and it's a package for **all platforms**.

Cbc (Coin-or linear programming) is an open-source linear programming solver. It is primarily meant to be used as a callable library, but a basic, stand-alone executable version is also available.

## Usage

Just add the following to your `Cargo.toml`:

```toml
[dependencies]
coincbc-sys = "0.2"
coincbc-sys = "\*"
```

## Configure
Expand All @@ -23,7 +24,8 @@ The following Cargo features are supported:
* `default` to build metadatahreaded `Cbc`;
* `parallel` to build `Cbc` with `pthread`;

## Library Linking
## Library Linking and Cross Compile

if you want to know the detail about how it compile or link the Cbc, please see [Cbc-src].

## Contribution
Expand Down

0 comments on commit 37c1268

Please sign in to comment.