Skip to content

Commit

Permalink
docs(docs): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AnzhiZhang committed Jul 20, 2024
1 parent d81c4e7 commit 9a3cbb7
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
# TypedMatrices

[![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)

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

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.

## Usage

### Quick Start

### API Reference

#### list_properties

#### list_groups

#### list_matrices

## Related Packages

- [MatrixDepot.jl](https://github.com/JuliaLinearAlgebra/MatrixDepot.jl)
- [SpecialMatrices.jl](https://github.com/JuliaLinearAlgebra/SpecialMatrices.jl)

## References

0 comments on commit 9a3cbb7

Please sign in to comment.