Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rileyjmurray committed Jun 4, 2024
1 parent 20b541e commit 58ee13e
Showing 1 changed file with 21 additions and 9 deletions.
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,32 @@ RandBLAS supports high-level randomized linear algebra algorithms (like randomiz
Our goal is for RandBLAS to become a standard like the BLAS, in that hardware vendors might
release their own optimized implementations of algorithms which confirm to the RandBLAS API.

For those who are new to randomized linear algebra, we recommend you check out [this superb 35-minute YouTube video](https://www.youtube.com/watch?v=6htbyY3rH1w) on the subject.
For those who are new to randomized linear algebra, we recommend you check out [this 35-minute YouTube video](https://www.youtube.com/watch?v=6htbyY3rH1w) on the subject.

### Source Code
### Source code

The source code can be obtained at the [RandBLAS github repository](https://github.com/BallisticLA/RandBLAS).
The source code can be found at the [RandBLAS github repository](https://github.com/BallisticLA/RandBLAS).

### Documentation

See [RandBLAS User's Guide](https://randblas.readthedocs.io/en/latest/) for a terse but thorough overview of RandBLAS' functionality.
We have three types of documentation.
1. Traditional source code comments.
2. Web documentation, split into a [tutorial](https://randblas.readthedocs.io/en/latest/tutorial/index.html) and an [API reference](https://randblas.readthedocs.io/en/latest/api_reference/index.html).
3. Developer notes; [one](https://github.com/BallisticLA/RandBLAS/blob/main/RandBLAS/DevNotes.md) for RandBLAS as a whole and [another](https://github.com/BallisticLA/RandBLAS/blob/main/RandBLAS/sparse_data/DevNotes.md) for our sparse matrix functionality.

### CI
![Ubuntu Latest](https://github.com/BallisticLA/RandBLAS/actions/workflows/core-linux.yaml/badge.svg)
![Macos Latest](https://github.com/BallisticLA/RandBLAS/actions/workflows/core-macos.yml/badge.svg)
Detailed installation instructions are in [INSTALL.md](INSTALL.md).

### Copyright and License
### Continuous integration builds

RandBLAS is licensed under the BSD 3-Clause License. See [license](LICENSE) for more information.
![Latest Ubuntu (OpenMP)](https://github.com/BallisticLA/RandBLAS/actions/workflows/core-linux.yaml/badge.svg)

![Latest macOS (serial)](https://github.com/BallisticLA/RandBLAS/actions/workflows/core-macos.yml/badge.svg)

![Latest macOS (OpenMP)](https://github.com/BallisticLA/RandBLAS/actions/workflows/openmp-macos.yaml/badge.svg)

![Old macOS (OpenMP)](https://github.com/BallisticLA/RandBLAS/actions/workflows/openmp-macos-13.yaml/badge.svg)

### Copyright and license

RandBLAS is licensed under the BSD 3-Clause License.
See [LICENSE](LICENSE) for information and copyright assertions.

0 comments on commit 58ee13e

Please sign in to comment.