Skip to content

Commit a0131e5

Browse files
committed
doc: update README to link to the html docs and fix links
Also some minor formatting improvements and linking the home page.
1 parent 18014b0 commit a0131e5

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,32 @@ OSUOSL IBMZ-CI [![Build Status](http://ibmz-ci.osuosl.org/buildStatus/icon?job=O
1515

1616
OpenBLAS is an optimized BLAS (Basic Linear Algebra Subprograms) library based on GotoBLAS2 1.13 BSD version.
1717

18-
Please read the documentation in the OpenBLAS folder: <https://github.com/OpenMathLib/OpenBLAS/docs>.
18+
For more information about OpenBLAS, please see:
19+
20+
- The documentation at [openmathlib.org/OpenBLAS/docs/](http://www.openmathlib.org/OpenBLAS/docs),
21+
- The home page at [openmathlib.org/OpenBLAS/](http://www.openmathlib.org/OpenBLAS).
1922

2023
For a general introduction to the BLAS routines, please refer to the extensive documentation of their reference implementation hosted at netlib:
2124
<https://www.netlib.org/blas>. On that site you will likewise find documentation for the reference implementation of the higher-level library LAPACK - the **L**inear **A**lgebra **Pack**age that comes included with OpenBLAS. If you are looking for a general primer or refresher on Linear Algebra, the set of six
22-
20-minute lecture videos by Prof. Gilbert Strang on either MIT OpenCourseWare <https://ocw.mit.edu/resources/res-18-010-a-2020-vision-of-linear-algebra-spring-2020/> or Youtube <https://www.youtube.com/playlist?list=PLUl4u3cNGP61iQEFiWLE21EJCxwmWvvek> may be helpful.
25+
20-minute lecture videos by Prof. Gilbert Strang on either MIT OpenCourseWare [here](https://ocw.mit.edu/resources/res-18-010-a-2020-vision-of-linear-algebra-spring-2020/) or YouTube [here](https://www.youtube.com/playlist?list=PLUl4u3cNGP61iQEFiWLE21EJCxwmWvvek) may be helpful.
2326

2427
## Binary Packages
2528

2629
We provide official binary packages for the following platform:
2730

2831
* Windows x86/x86_64
2932

30-
You can download them from [file hosting on sourceforge.net](https://sourceforge.net/projects/openblas/files/) or from the Releases section of the github project page, [https://github.com/OpenMathLib/OpenBLAS/releases](https://github.com/OpenMathLib/OpenBLAS/releases).
33+
You can download them from [file hosting on sourceforge.net](https://sourceforge.net/projects/openblas/files/) or from the [Releases section of the GitHub project page](https://github.com/OpenMathLib/OpenBLAS/releases).
34+
35+
OpenBLAS is also packaged for many package managers - see [the installation section of the docs](http://www.openmathlib.org/OpenBLAS/docs/install/) for details.
3136

3237
## Installation from Source
3338

34-
Download from project homepage, https://github.com/OpenMathLib/OpenBLAS/, or check out the code
35-
using Git from https://github.com/OpenMathLib/OpenBLAS.git. (If you want the most up to date version, be
36-
sure to use the develop branch - master is several years out of date due to a change of maintainership.)
37-
Buildtime parameters can be chosen in Makefile.rule, see there for a short description of each option.
38-
Most can also be given directly on the make or cmake command line.
39+
Obtain the source code from https://github.com/OpenMathLib/OpenBLAS/. Note that the default branch
40+
is `develop` (a `master` branch is still present, but far out of date).
41+
42+
Build-time parameters can be chosen in `Makefile.rule`, see there for a short description of each option.
43+
Most options can also be given directly on the command line as parameters to your `make` or `cmake` invocation.
3944

4045
### Dependencies
4146

@@ -60,6 +65,9 @@ For building with `cmake`, the usual conventions apply, i.e. create a build dire
6065
OpenBLAS source directory or separate from it, and invoke `cmake` there with the path to the source tree and any
6166
build options you plan to set.
6267

68+
For more details, see the [Building from source](http://www.openmathlib.org/OpenBLAS/docs/install/#building-from-source)
69+
section in the docs.
70+
6371
### Cross compile
6472

6573
Set `CC` and `FC` to point to the cross toolchains, and if you use `make`, also set `HOSTCC` to your host C compiler.
@@ -76,10 +84,12 @@ Examples:
7684
make CC="i686-w64-mingw32-gcc -Bstatic" FC="i686-w64-mingw32-gfortran -static-libgfortran" TARGET=HASWELL BINARY=32 CROSS=1 NUM_THREADS=20 CONSISTENT_FPCSR=1 HOSTCC=gcc
7785
```
7886

79-
You can find instructions for other cases both in the "Supported Systems" section below and in the docs folder. The .yml scripts included with the sources (which contain the
87+
You can find instructions for other cases both in the "Supported Systems" section below and in
88+
the [Building from source docs](http://www.openmathlib.org/OpenBLAS/docs/install).
89+
The `.yml` scripts included with the sources (which contain the
8090
build scripts for the "continuous integration" (CI) build tests automatically run on every proposed change to the sources) may also provide additional hints.
8191

82-
When compiling for a more modern CPU TARGET of the same architecture, e.g. TARGET=SKYLAKEX on a HASWELL host, option "CROSS=1" can be used to suppress the automatic invocation of the tests at the end of the build.
92+
When compiling for a more modern CPU target of the same architecture, e.g. `TARGET=SKYLAKEX` on a `HASWELL` host, option `CROSS=1` can be used to suppress the automatic invocation of the tests at the end of the build.
8393

8494
### Debug version
8595

@@ -325,7 +335,7 @@ Please see Changelog.txt.
325335
326336
## Troubleshooting
327337
328-
* Please read the [FAQ](https://github.com/OpenMathLib/OpenBLAS/docs/faq,md) in the docs folder first.
338+
* Please read the [FAQ](www.openmathlib.org/OpenBLAS/docs/faq) section of the docs first.
329339
* Please use GCC version 4.6 and above to compile Sandy Bridge AVX kernels on Linux/MinGW/BSD.
330340
* Please use Clang version 3.1 and above to compile the library on Sandy Bridge microarchitecture.
331341
Clang 3.0 will generate the wrong AVX binary code.
@@ -350,4 +360,4 @@ Please see Changelog.txt.
350360
351361
## Donation
352362
353-
Please read [this wiki page](https://github.com/xianyi/OpenBLAS/wiki/Donation).
363+
Please see [the donations section](http://www.openmathlib.org/OpenBLAS/docs/about/#donations) in the docs.

0 commit comments

Comments
 (0)