Skip to content

Commit b453f8e

Browse files
authored
Merge pull request #103 from jturner314/explain-test-backend
Explain in README how to run tests and examples
2 parents b9ed2c9 + bb953e8 commit b453f8e

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,23 @@ ndarray-linalg = { version = "0.9", default-features = false }
5757

5858
However, if you hope simplicity instead of the flexibility, you can link your favorite backend in the way described above.
5959

60+
### Tests and Examples
61+
62+
To run tests or examples for `ndarray-linalg`, you must specify the desired
63+
backend. For example, you can run the tests with the OpenBLAS backend like
64+
this:
65+
66+
```sh
67+
cargo test --features=openblas
68+
```
69+
6070
Examples
6171
---------
6272
See [examples](https://github.com/termoshtt/ndarray-linalg/tree/master/examples) directory.
6373

74+
Note that to run an example, you must specify the desired backend. For example,
75+
you can run the the `solve` example with the OpenBLAS backend like this:
76+
77+
```sh
78+
cargo run --example solve --features=openblas
79+
```

0 commit comments

Comments
 (0)