Skip to content

Commit fb7faf1

Browse files
committed
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.
1 parent 59c1ce0 commit fb7faf1

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.rst

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ Highlights
3636
elements from the end of the axis.
3737
- Views and subviews of arrays; iterators that yield subviews.
3838

39+
Installation
40+
------------
41+
From a shell in your project folder, run `cargo add ndarray` to add the latest version.
42+
3943
Status and Lookout
4044
------------------
4145

@@ -85,7 +89,7 @@ your `Cargo.toml`.
8589

8690
- ``approx``
8791

88-
- Implementations of traits from version 0.5 of the [`approx`] crate.
92+
- Implementations of traits the [`approx`] crate.
8993

9094
- ``blas``
9195

@@ -101,14 +105,6 @@ your `Cargo.toml`.
101105

102106
- Whether ``portable-atomic`` should use ``critical-section``
103107

104-
How to use with cargo
105-
---------------------
106-
107-
::
108-
109-
[dependencies]
110-
ndarray = "0.16.0"
111-
112108
How to enable BLAS integration
113109
------------------------------
114110

@@ -127,15 +123,15 @@ An example configuration using system openblas is shown below. Note that only
127123
end-user projects (not libraries) should select provider::
128124

129125
[dependencies]
130-
ndarray = { version = "0.16.0", features = ["blas"] }
126+
ndarray = { version = "0.x.y", features = ["blas"] }
131127
blas-src = { version = "0.10", features = ["openblas"] }
132128
openblas-src = { version = "0.10", features = ["cblas", "system"] }
133129

134130
Using system-installed dependencies can save a long time building dependencies.
135131
An example configuration using (compiled) netlib is shown below anyway::
136132

137133
[dependencies]
138-
ndarray = { version = "0.16.0", features = ["blas"] }
134+
ndarray = { version = "0.x.y", features = ["blas"] }
139135
blas-src = { version = "0.10.0", default-features = false, features = ["netlib"] }
140136

141137
When this is done, your program must also link to ``blas_src`` by using it or

0 commit comments

Comments
 (0)