From fb7faf1fa2279870c275f67930e29d10d9c019ec Mon Sep 17 00:00:00 2001 From: Adam Kern Date: Sat, 10 Jan 2026 17:53:02 -0500 Subject: [PATCH] Remove most version specifiers in `README` As we try to release versions more quickly, I'd like to avoid our README looking out of date. I suspect that almost everyone nowadays uses `cargo add` to add dependencies, rather than putting them directly into their `Cargo.toml`, so I've opted to just add a short instruction for installation. --- README.rst | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 49558b1c1..8deda7f5f 100644 --- a/README.rst +++ b/README.rst @@ -36,6 +36,10 @@ Highlights elements from the end of the axis. - Views and subviews of arrays; iterators that yield subviews. +Installation +------------ +From a shell in your project folder, run `cargo add ndarray` to add the latest version. + Status and Lookout ------------------ @@ -85,7 +89,7 @@ your `Cargo.toml`. - ``approx`` - - Implementations of traits from version 0.5 of the [`approx`] crate. + - Implementations of traits the [`approx`] crate. - ``blas`` @@ -101,14 +105,6 @@ your `Cargo.toml`. - Whether ``portable-atomic`` should use ``critical-section`` -How to use with cargo ---------------------- - -:: - - [dependencies] - ndarray = "0.16.0" - How to enable BLAS integration ------------------------------ @@ -127,7 +123,7 @@ An example configuration using system openblas is shown below. Note that only end-user projects (not libraries) should select provider:: [dependencies] - ndarray = { version = "0.16.0", features = ["blas"] } + ndarray = { version = "0.x.y", features = ["blas"] } blas-src = { version = "0.10", features = ["openblas"] } openblas-src = { version = "0.10", features = ["cblas", "system"] } @@ -135,7 +131,7 @@ Using system-installed dependencies can save a long time building dependencies. An example configuration using (compiled) netlib is shown below anyway:: [dependencies] - ndarray = { version = "0.16.0", features = ["blas"] } + ndarray = { version = "0.x.y", features = ["blas"] } blas-src = { version = "0.10.0", default-features = false, features = ["netlib"] } When this is done, your program must also link to ``blas_src`` by using it or