Skip to content

Commit d5466f7

Browse files
committed
Add a link to the usage page
1 parent 295e30f commit d5466f7

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# LAPACK [![Package][package-img]][package-url] [![Documentation][documentation-img]][documentation-url] [![Build][build-img]][build-url]
22

3-
The package provides wrappers for [LAPACK] (Fortran).
3+
The package provides wrappers for [LAPACK] (Fortran). The usage of the package
4+
is explained [here][usage].
45

56
## Example
67

@@ -31,6 +32,7 @@ pull request. Note that any contribution submitted for inclusion in the project
3132
will be licensed according to the terms given in [LICENSE.md](LICENSE.md).
3233

3334
[lapack]: https://en.wikipedia.org/wiki/LAPACK
35+
[usage]: https://blas-lapack-rs.github.io/usage
3436

3537
[build-img]: https://travis-ci.org/blas-lapack-rs/lapack.svg?branch=master
3638
[build-url]: https://travis-ci.org/blas-lapack-rs/lapack

src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
//! Wrappers for [LAPACK] \(Fortran)
22
//!
3+
//! The usage of the package is explained [here][usage].
4+
//!
35
//! ## Example
46
//!
57
//! ```no_run
@@ -23,6 +25,7 @@
2325
//! ```
2426
//!
2527
//! [lapack]: https://en.wikipedia.org/wiki/LAPACK
28+
//! [usage]: https://blas-lapack-rs.github.io/usage
2629

2730
extern crate lapack_sys as ffi;
2831
extern crate libc;

0 commit comments

Comments
 (0)