From eafc61b4cf7d98fb2a337427283b6730d9099a6a Mon Sep 17 00:00:00 2001 From: Mohammed Ghannam Date: Sat, 30 Mar 2024 12:09:28 +0100 Subject: [PATCH] Propagate the from-source scip-sys feature (#135) --- Cargo.toml | 3 ++- README.md | 18 ++++++++++-------- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index d55f4c5..df7158b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,9 +11,10 @@ exclude = ["data/test/*"] [features] raw = [] bundled = ["scip-sys/bundled"] +from-source = ["scip-sys/from-source"] [dependencies] -scip-sys = "0.1.9" +scip-sys = "0.1.11" [dev-dependencies] rayon = "1.5.1" diff --git a/README.md b/README.md index 43251ef..f520f1f 100644 --- a/README.md +++ b/README.md @@ -17,22 +17,24 @@ A safe Rust interface for [SCIP](https://www.scipopt.org/index.php#download). Th The project is currently actively developed, issues/pull-requests are very welcome. ## Installation + By running ```bash cargo add russcip --features bundled ``` -or to get the most recent version, add the following to your `Cargo.toml` -```toml -[dependencies] -russcip = { git = "https://github.com/scipopt/russcip", features = ["bundled"] } -``` The `bundled` feature will download a precompiled SCIP as part of the build process. -This is the easiest to get started with russcip, if you want to use a custom SCIP installation check the [section](#custom-scip-installation) below. +This is the easiest to get started with russcip, instead you could try the [from-source](#from-source-feature) +or if you want to link against your custom SCIP installation check the [section](#custom-scip-installation) below. +### `from-source` feature +To build SCIP from source, you can enable the `from-source` feature. This will download the SCIP source code and build it as part of the build process. +```bash +cargo add russcip --features from-source +``` -## Custom SCIP installation -If the `bundled` feature is not enabled, `russcip` will look for a scip installation in the current conda environment, +### Custom SCIP installation +If no feature is not enabled, `russcip` will look for a scip installation in the current conda environment, to install SCIP using conda run the following command ```bash conda install --channel conda-forge scip