From e6dba05689d01354542531b129b0a3a5d8a39abd Mon Sep 17 00:00:00 2001 From: Alexis Montoison Date: Mon, 21 Jun 2021 14:09:37 -0400 Subject: [PATCH] Update README.md --- README.md | 23 +++++++++++++++++------ TODO.md | 8 -------- 2 files changed, 17 insertions(+), 14 deletions(-) delete mode 100644 TODO.md diff --git a/README.md b/README.md index f93761ec..6770bd96 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,21 @@ # A [Julia](http://julialang.org) Linear Operator Package -[![DOI](https://zenodo.org/badge/20136006.svg)](https://zenodo.org/badge/latestdoi/20136006) -[![Build Status](https://github.com/JuliaSmoothOptimizers/LinearOperators.jl/workflows/CI/badge.svg?branch=master)](https://github.com/JuliaSmoothOptimizers/LinearOperators.jl/actions) -[![Build Status](https://api.cirrus-ci.com/github/JuliaSmoothOptimizers/LinearOperators.jl.svg)](https://cirrus-ci.com/github/JuliaSmoothOptimizers/LinearOperators.jl) -[![codecov.io](https://codecov.io/github/JuliaSmoothOptimizers/LinearOperators.jl/coverage.svg?branch=master)](https://codecov.io/github/JuliaSmoothOptimizers/LinearOperators.jl?branch=master) -[![docs](https://img.shields.io/badge/docs-latest-3f51b5.svg)](https://JuliaSmoothOptimizers.github.io/LinearOperators.jl/latest) +| **Documentation** | **Linux/macOS/Windows/FreeBSD** | **Coverage** | **DOI** | +|:-----------------:|:-------------------------------:|:------------:|:-------:| +| [![docs-stable][docs-stable-img]][docs-stable-url] [![docs-dev][docs-dev-img]][docs-dev-url] | [![build-gh][build-gh-img]][build-gh-url] [![build-cirrus][build-cirrus-img]][build-cirrus-url] | [![codecov][codecov-img]][codecov-url] | [![doi][doi-img]][doi-url] | + +[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg +[docs-stable-url]: https://JuliaSmoothOptimizers.github.io/LinearOperators.jl/stable +[docs-dev-img]: https://img.shields.io/badge/docs-dev-purple.svg +[docs-dev-url]: https://JuliaSmoothOptimizers.github.io/LinearOperators.jl/dev +[build-gh-img]: https://github.com/JuliaSmoothOptimizers/LinearOperators.jl/workflows/CI/badge.svg?branch=master +[build-gh-url]: https://github.com/JuliaSmoothOptimizers/LinearOperators.jl/actions +[build-cirrus-img]: https://img.shields.io/cirrus/github/JuliaSmoothOptimizers/LinearOperators.jl?logo=Cirrus%20CI +[build-cirrus-url]: https://cirrus-ci.com/github/JuliaSmoothOptimizers/LinearOperators.jl +[codecov-img]: https://codecov.io/gh/JuliaSmoothOptimizers/LinearOperators.jl/branch/master/graph/badge.svg +[codecov-url]: https://app.codecov.io/gh/JuliaSmoothOptimizers/LinearOperators.jl +[doi-img]: https://zenodo.org/badge/20136006.svg +[doi-url]: https://zenodo.org/badge/latestdoi/20136006 ## How to Cite @@ -16,7 +27,7 @@ Operators behave like matrices (with some exceptions - see below) but are define ## Compatibility -Julia 1.0 and up. +Julia 1.3 and up. ## How to Install diff --git a/TODO.md b/TODO.md deleted file mode 100644 index af54de74..00000000 --- a/TODO.md +++ /dev/null @@ -1,8 +0,0 @@ -# To Do List - -- [ ] operator for sparse triangular solves with implicit unit diagonal - (e.g., for [LLDL](https://github.com/optimizers/lldl)) -- [X] block operators, e.g., `[A B ; C D]` (in e942fc0) -- [ ] restriction operator, e.g., `A[1:n,1:m]`. -- [ ] `normest()` -- [ ] `condest()`