Skip to content

Commit 3f06a48

Browse files
committed
Update README
1 parent 7c6b96e commit 3f06a48

File tree

1 file changed

+24
-22
lines changed

1 file changed

+24
-22
lines changed

README.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# intel-mkl-src
22

3+
[![changelog](https://img.shields.io/badge/CHANGELOG-Unreleased-informational)](./CHANGELOG.md)
4+
35
|crate | crate.io | docs.rs | description |
46
|:-------------|:-------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------|:---------------------------------------------------------------|
57
|intel-mkl-src | [![crate](https://img.shields.io/crates/v/intel-mkl-src.svg)](https://crates.io/crates/intel-mkl-src) | [![docs.rs](https://docs.rs/intel-mkl-src/badge.svg)](https://docs.rs/intel-mkl-src) | Source crate for Intel-MKL |
@@ -9,6 +11,28 @@
911
[VM]: https://software.intel.com/en-us/mkl-developer-reference-c-vector-mathematical-functions
1012
[VSL]: https://software.intel.com/en-us/mkl-developer-reference-c-statistical-functions
1113

14+
## Usage
15+
16+
This crate is a `*-src` crate. This downloads and link Intel MKL, but does not introduce any symbols.
17+
Please use `blas-sys`, `lapack-sys`, or `fftw-sys` to use BLAS, LAPACK, FFTW interface of MKL, e.g.
18+
19+
```toml
20+
[dependencies]
21+
fftw-sys = { version = "0.4", features = ["intel-mkl"] }
22+
```
23+
24+
## How to find system MKL libraries
25+
26+
`intel-mkl-tool` crate seeks system MKL libraries, e.g. installed by various installer as following manner:
27+
28+
- Seek using `pkg-config` command
29+
- Seek `${MKLROOT}` directory
30+
- Seek default installation path
31+
- `/opt/intel/mkl` for Linux
32+
- `C:/Program Files (x86)/IntelSWTools/` and `C:/Program Files (x86)/Intel/oneAPI` for Windows
33+
34+
If `intel-mkl-tool` cannot find system MKL, `intel-mkl-src` try to download MKL binaries from OCI Registry.
35+
1236
## Supported features
1337

1438
`mkl-*-*-*` features specify which MKL to be linked as following.
@@ -36,28 +60,6 @@ This specify the data model:
3660

3761
Using GNU OpenMP runtime (`libgomp`) is not supported in this project.
3862

39-
## Usage
40-
41-
This crate is a `*-src` crate. This downloads and link Intel MKL, but does not introduce any symbols.
42-
Please use `blas-sys`, `lapack-sys`, or `fftw-sys` to use BLAS, LAPACK, FFTW interface of MKL, e.g.
43-
44-
```toml
45-
[dependencies]
46-
fftw-sys = { version = "0.4", features = ["intel-mkl"] }
47-
```
48-
49-
## How to find system MKL libraries
50-
51-
`intel-mkl-tool` crate seeks system MKL libraries, e.g. installed by various installer as following manner:
52-
53-
- Seek using `pkg-config` command
54-
- Seek `${MKLROOT}` directory
55-
- Seek default installation path
56-
- `/opt/intel/mkl` for Linux
57-
- `C:/Program Files (x86)/IntelSWTools/` and `C:/Program Files (x86)/Intel/oneAPI` for Windows
58-
59-
If `intel-mkl-tool` cannot find system MKL, `intel-mkl-src` try to download MKL binaries from OCI Registry.
60-
6163
## License
6264
MKL is distributed under the Intel Simplified Software License for Intel(R) Math Kernel Library, See [License.txt](License.txt).
6365
Some wrapper codes are licensed by MIT License (see the header of each file).

0 commit comments

Comments
 (0)