Skip to content

Commit a9a532b

Browse files
committed
Polish the readme
1 parent ff4d434 commit a9a532b

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ The package provides a source of [BLAS] and [LAPACK] via [OpenBLAS].
88

99
The following Cargo features are supported:
1010

11-
* `cache` to build in shared directory e.g. `$XDG_DATA_HOME/openblas_build/` instead of `target` (see below),
11+
* `cache` to build in shared directory, e.g., `${XDG_DATA_HOME}/openblas_build/`
12+
instead of `target` (see below),
1213
* `cblas` to build CBLAS (enabled by default),
1314
* `lapacke` to build LAPACKE (enabled by default),
1415
* `static` to link to OpenBLAS statically, and
@@ -17,16 +18,16 @@ The following Cargo features are supported:
1718
## Caching
1819

1920
The `cache` feature allows the OpenBLAS build products to be reused between
20-
crates that have different `target` directories.
21-
This avoids rebuilding OpenBLAS unnecessarily.
22-
However, this also prevents `cargo clean` from working properly,
21+
crates that have different `target` directories. This avoids rebuilding OpenBLAS
22+
unnecessarily. However, this also prevents `cargo clean` from working properly,
2323
since the aforementioned build products will not be removed by the command.
2424

25-
The OpenBLAS binary will be placed at `$XDG_DATA_HOME/openblas_build/[hash of build configure object]`.
26-
For example, build with LAPACK and build without LAPACK will be placed on different directories.
27-
If you build OpenBLAS as a shared library, you need to add the above directory to
28-
`LD_LIBRARY_PATH` (for Linux) or `DYLD_LIBRARY_PATH` (for macOS).
29-
Since build from source is not supported on Windows (see next section), this feature is also not supported.
25+
The OpenBLAS binary will be placed at `${XDG_DATA_HOME}/openblas_build/[hash of
26+
build configure object]`. For example, build with LAPACK and build without
27+
LAPACK will be placed on different directories. If you build OpenBLAS as a
28+
shared library, you need to add the above directory to `LD_LIBRARY_PATH` (for
29+
Linux) or `DYLD_LIBRARY_PATH` (for macOS). Since build from source is not
30+
supported on Windows (see next section), this feature is also not supported.
3031

3132
## Windows and vcpkg
3233

0 commit comments

Comments
 (0)