Skip to content

Commit 4f0093d

Browse files
Update README with installation and usage instructions
- Add comprehensive README with project overview - Include installation steps using git clone and package instantiation - Provide usage example demonstrating forward substitution - Showcase library functionality with a simple code snippet
1 parent 1219a12 commit 4f0093d

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,30 @@
22

33
[![Build Status](https://github.com/yangjunjie0320/SimpleLinearAlgebra.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/yangjunjie0320/SimpleLinearAlgebra.jl/actions/workflows/CI.yml?query=branch%3Amain)
44
[![Coverage](https://codecov.io/gh/yangjunjie0320/SimpleLinearAlgebra.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/yangjunjie0320/SimpleLinearAlgebra.jl)
5+
6+
This is a simple linear algebra library that builds upon `julia` language.
7+
8+
## Installation
9+
10+
```bash
11+
git clone https://github.com/yangjunjie0320/SimpleLinearAlgebra.jl
12+
cd SimpleLinearAlgebra.jl
13+
julia --project=. -e 'using Pkg; Pkg.instantiate()'
14+
```
15+
16+
## Usage
17+
18+
```julia
19+
using LinearAlgebra
20+
using SimpleLinearAlgebra
21+
22+
# forward substitution
23+
l = tril(rand(10, 10))
24+
b = rand(10)
25+
prob = ForwardSubstitution(l, b)
26+
soln = kernel(prob)
27+
28+
x = soln.x
29+
@assert isapprox(l * x, b, atol=1e-10)
30+
```
31+

0 commit comments

Comments
 (0)