From 40234d18e7943f42f1b5ebf8599fd7af076506b2 Mon Sep 17 00:00:00 2001 From: Arthur Carcano <53921575+krtab@users.noreply.github.com> Date: Fri, 11 Jun 2021 12:51:29 +0200 Subject: [PATCH] doc --- Readme.md | 4 ++++ src/lib.rs | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/Readme.md b/Readme.md index 89ee107..6a71880 100644 --- a/Readme.md +++ b/Readme.md @@ -2,6 +2,10 @@ A wrapper around the cvode(S) ODE solver from sundials. [ [documentation](https://docs.rs/cvode-wrap) ] [ [lib.rs](https://lib.rs/crates/cvode-wrap) ] [ [git repository](https://gitlab.inria.fr/InBio/Public/cvode-rust-wrap) ] +# Building sundials + +To build sundials, activate the `sundials-sys/build_libraries` feature. + # Examples ## Oscillator diff --git a/src/lib.rs b/src/lib.rs index 95d16b9..969f496 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,6 +1,11 @@ //! A wrapper around cvode and cvodes from the sundials tool suite. //! //! Users should be mostly interested in [`SolverSensi`] and [`SolverNoSensi`]. +//! +//! # Building sundials +//! +//! To build sundials, activate the `sundials-sys/build_libraries` feature. +//! //! # Examples //! //! ## Oscillator