Skip to content

Commit 72c36f5

Browse files
committed
docs(docs): update readme
1 parent f8d2796 commit 72c36f5

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

Diff for: README.md

+23-12
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,37 @@
11
# TypedMatrices
22

3-
[![Build Status](https://github.com/AnzhiZhang/TypedMatrices.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/AnzhiZhang/TypedMatrices.jl/actions/workflows/CI.yml?query=branch%3Amaster)
3+
[![license][license-img]][license-url]
4+
[![action status][action-img]][action-url]
5+
[![docs-stable][docs-stable-img]][docs-stable-url]
6+
[![docs-dev][docs-dev-img]][docs-dev-url]
7+
[![release][release-img]][release-url]
48

59
An extensible [Julia](https://julialang.org/) matrix collection utilizing type system to enhance performance.
610

711
This package provides new matrix types that can be used in Julia [LinearAlgebra](https://docs.julialang.org/en/v1/stdlib/LinearAlgebra/). Each matrix is a new subtype of `AbstractMatrix`, they are stored and computed efficiently.
812

913
## Usage
1014

11-
### Quick Start
12-
13-
### API Reference
14-
15-
#### list_properties
16-
17-
#### list_groups
18-
19-
#### list_matrices
15+
Check [documentation][docs-stable-url] for more details.
2016

2117
## Related Packages
2218

23-
- [MatrixDepot.jl](https://github.com/JuliaLinearAlgebra/MatrixDepot.jl)
24-
- [SpecialMatrices.jl](https://github.com/JuliaLinearAlgebra/SpecialMatrices.jl)
19+
We sincerly appreciate the following packages:
20+
21+
- [MatrixDepot.jl](https://github.com/JuliaLinearAlgebra/MatrixDepot.jl): some matrices' generation algorithm are inspired and adapted from this package.
22+
- [SpecialMatrices.jl](https://github.com/JuliaLinearAlgebra/SpecialMatrices.jl): code structure and some matrices' manipulation functions are inspired and adapted from this package.
2523

2624
## References
25+
26+
- Nicholas J. Higham, "Algorithm 694, A Collection of Test Matrices in MATLAB", *ACM Trans. Math. Software*, vol. 17. (1991), pp 289-305 [[pdf]](http://www.maths.manchester.ac.uk/~higham/narep/narep172.pdf) [[doi]](https://dx.doi.org/10.1145/114697.116805)
27+
28+
[license-img]: https://shields.io/github/license/AnzhiZhang/TypedMatrices.jl
29+
[license-url]: LICENSE
30+
[action-img]: https://github.com/AnzhiZhang/TypedMatrices.jl/actions/workflows/CI.yml/badge.svg?branch=master
31+
[action-url]: https://github.com/AnzhiZhang/TypedMatrices.jl/actions/workflows/CI.yml?query=branch%3Amaster
32+
[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
33+
[docs-stable-url]: https://typedmatrices.zhanganzhi.com/stable
34+
[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
35+
[docs-dev-url]: https://typedmatrices.zhanganzhi.com/dev/
36+
[release-img]: https://shields.io/github/v/release/AnzhiZhang/TypedMatrices.jl?display_name=tag&include_prereleases
37+
[release-url]: https://github.com/AnzhiZhang/TypedMatrices.jl/releases/latest

0 commit comments

Comments
 (0)