Skip to content

Explain in README how to run tests and examples #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 14, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,23 @@ ndarray-linalg = { version = "0.9", default-features = false }

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

### Tests and Examples
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"###" at 60 is typo?


To run tests or examples for `ndarray-linalg`, you must specify the desired
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"ndarray-linalg," at 62 is typo?

  • arrayer-linalg`,
  • array-linalg`,
  • Raynard-linalg`,
  • boundary-linalg`,
  • quandary-linalg`,

backend. For example, you can run the tests with the OpenBLAS backend like
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"backend" at 63 is typo?

  • backed
  • back end
  • back-end
  • backhand
  • bracken

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"OpenBLAS" at 63 is typo?

  • Opencast
  • Operas
  • Penelope
  • Openness
  • Spoonbill

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"example," at 63 is typo?

  • example
  • examples
  • exampled
  • sample
  • ample

this:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"this:" at 64 is typo?

  • this
  • hist
  • thirst
  • thesis


```sh
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"```sh" at 66 is typo?

  • clash
  • flesh

cargo test --features=openblas
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"--features=openblas" at 67 is typo?

  • --featureless
  • --irresponsibleness
  • --irresponsibility
  • features
  • impressionableness

```
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"```" at 68 is typo?


Examples
---------
See [examples](https://github.com/termoshtt/ndarray-linalg/tree/master/examples) directory.

Note that to run an example, you must specify the desired backend. For example,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"backend" at 74 is typo?

  • backed
  • back end
  • back-end
  • backhand
  • bracken

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"example," at 74 is typo?

  • example
  • examples
  • exampled
  • sample
  • ample

you can run the the `solve` example with the OpenBLAS backend like this:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"OpenBLAS" at 75 is typo?

  • Opencast
  • Operas
  • Penelope
  • Openness
  • Spoonbill

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"backend" at 75 is typo?

  • backed
  • back end
  • back-end
  • backhand
  • bracken

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"this:" at 75 is typo?

  • this
  • hist
  • thirst
  • thesis

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"solve" at 75 is typo?

  • solve
  • solvable
  • Soloviev


```sh
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"```sh" at 77 is typo?

  • clash
  • flesh

cargo run --example solve --features=openblas
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"--features=openblas" at 78 is typo?

  • --featureless
  • --irresponsibleness
  • --irresponsibility
  • features
  • impressionableness

```
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"```" at 79 is typo?