Skip to content

Commit

Permalink
changed to CITATION.cff
Browse files Browse the repository at this point in the history
  • Loading branch information
Jay-sanjay authored Apr 2, 2024
1 parent a8791f6 commit 9f92967
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 1 deletion.
15 changes: 15 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
authors:
- family-names: "Kenens"
given-names: "Antonin"
title: "KrylovPreconditioners.jl : The ultimate collection of preconditioners "
date-released: '2023-11-20'
version: 0.2.2
license: MPL-2.0
repository-code: "https://github.com/JuliaSmoothOptimizers/KrylovPreconditioners.jl"
keywords:
- Least squares
- Julia
- preconditioners
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# KrylovPreconditioners.jl
# `KrylovPreconditioners`.jl

| **Documentation** | **CI** | **Coverage** | **Downloads** |
|:-----------------:|:------:|:------------:|:-------------:|
Expand All @@ -17,4 +17,8 @@
[downloads-img]: https://shields.io/endpoint?url=https://pkgs.genieframework.com/api/v1/badge/KrylovPreconditioners
[downloads-url]: https://pkgs.genieframework.com?packages=KrylovPreconditioners

## How to Cite

If you use KrylovPreconditioners.jl in your work, please cite using the format given in [`CITATION.cff`](https://github.com/JuliaSmoothOptimizers/KrylovPreconditioners.jl/blob/main/CITATION.cff).

The best sidekick of [Krylov.jl](https://github.com/JuliaSmoothOptimizers/Krylov.jl) └(^o^ )X( ^o^)┘
2 changes: 2 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# [KrylovPreconditioners.jl documentation](@id Home)

This package provides a collection of preconditioners.
## How to Cite

If you use KrylovPreconditioners.jl in your work, please cite using the format given in [`CITATION.cff`](https://github.com/JuliaSmoothOptimizers/KrylovPreconditioners.jl/blob/main/CITATION.cff).
## How to Install

KrylovPreconditioners.jl can be installed and tested through the Julia package manager:
Expand Down

0 comments on commit 9f92967

Please sign in to comment.