Skip to content

Commit 129f7f3

Browse files
committed
Update the description of the package
1 parent dea6fb5 commit 129f7f3

File tree

3 files changed

+27
-20
lines changed

3 files changed

+27
-20
lines changed

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[package]
22
name = "netlib-src"
3-
version = "0.7.1"
3+
version = "0.7.2"
44
license = "Apache-2.0/MIT"
55
authors = [
66
"Corey Richardson <[email protected]>",
77
"Ivan Ukhov <[email protected]>",
88
"Mason Smith <[email protected]>",
99
]
10-
description = "The package provides BLAS and LAPACK using the Netlib implementation."
10+
description = "The package provides an implementation of BLAS and LAPACK via Netlib."
1111
homepage = "https://github.com/cmr/netlib-src"
1212
repository = "https://github.com/cmr/netlib-src"
1313
readme = "README.md"

README.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# netlib-src [![Package][package-img]][package-url] [![Build][build-img]][build-url]
1+
# netlib-src [![Package][package-img]][package-url] [![Documentation][documentation-img]][documentation-url] [![Build][build-img]][build-url]
22

3-
The package provides [BLAS][1] and [LAPACK][2] using the [Netlib][3]
4-
implementation. By default, the package will build and use a bundled Netlib,
5-
which requires a Fortran and C compiler.
3+
The package provides an implementation of [BLAS] and [LAPACK] via [Netlib]. The
4+
usage of the package is explained [here][usage].
65

76
The following Cargo features are supported:
87

@@ -11,28 +10,20 @@ The following Cargo features are supported:
1110
* `static` to link to Netlib statically, and
1211
* `system` to skip building the bundled Netlib.
1312

14-
## Where are all the FFI definitions?
15-
16-
This package provides only an implementation of BLAS and LAPACK. Bindings are
17-
available in [blas-sys][4] and [lapack-sys][5], and wrappers are available in
18-
[blas][6] and [lapack][7].
19-
2013
## Contribution
2114

2215
Your contribution is highly appreciated. Do not hesitate to open an issue or a
2316
pull request. Note that any contribution submitted for inclusion in the project
2417
will be licensed according to the terms given in [LICENSE.md](LICENSE.md).
2518

26-
[1]: https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms
27-
[2]: https://en.wikipedia.org/wiki/LAPACK
28-
[3]: http://www.netlib.org/lapack
29-
30-
[4]: https://github.com/stainless-steel/blas-sys
31-
[5]: https://github.com/stainless-steel/lapack-sys
32-
[6]: https://github.com/stainless-steel/blas
33-
[7]: https://github.com/stainless-steel/lapack
19+
[blas]: https://en.wikipedia.org/wiki/BLAS
20+
[lapack]: https://en.wikipedia.org/wiki/LAPACK
21+
[netlib]: http://www.netlib.org/
22+
[usage]: https://blas-lapack-rs.github.io/usage
3423

3524
[build-img]: https://travis-ci.org/cmr/netlib-src.svg?branch=master
3625
[build-url]: https://travis-ci.org/cmr/netlib-src
26+
[documentation-img]: https://docs.rs/netlib-src/badge.svg
27+
[documentation-url]: https://docs.rs/netlib-src
3728
[package-img]: https://img.shields.io/crates/v/netlib-src.svg
3829
[package-url]: https://crates.io/crates/netlib-src

src/lib.rs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,17 @@
1+
//! Implementation of [BLAS] and [LAPACK] via [Netlib]
2+
//!
3+
//! The usage of the package is explained [here][usage].
4+
//!
5+
//! The following Cargo features are supported:
6+
//!
7+
//! * `cblas` to build CBLAS (enabled by default),
8+
//! * `lapacke` to build LAPACKE (enabled by default),
9+
//! * `static` to link to Netlib statically, and
10+
//! * `system` to skip building the bundled Netlib.
11+
//!
12+
//! [blas]: https://en.wikipedia.org/wiki/BLAS
13+
//! [lapack]: https://en.wikipedia.org/wiki/LAPACK
14+
//! [netlib]: http://www.netlib.org/
15+
//! [usage]: https://blas-lapack-rs.github.io/usage
16+
117
#![no_std]

0 commit comments

Comments
 (0)