Skip to content

Commit 522381f

Browse files
authored
Added changelog (#41)
* Added changelog * Restructured the changelog * Updated readme for doc * Remade the table in readme * Changed to Release Candidate * Updated installation * Updated installation in doc
1 parent 30a7cdd commit 522381f

File tree

4 files changed

+30
-4
lines changed

4 files changed

+30
-4
lines changed

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Changelog #
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## Release Candidate ##
6+
7+
[Full Changelog](https://github.com/hifirworks/hifir/compare/v0.1.0...HEAD)
8+
9+
## [v0.1.0](https://github.com/hifirworks/hifir/releases/tag/v0.1.0) (2021-08-22) ##
10+
11+
This is the initial official release of the HIFIR package.

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,25 @@
11
# Welcome to *HIFIR* Project #
22

3+
|CI | Documentation |
4+
|:---: | :---:|
5+
| ![HIFIR](https://github.com/hifirworks/hifir/actions/workflows/github-actions.yml/badge.svg?branch=main) | [![doc](https://img.shields.io/badge/%20doc-ready-blue)](https://hifirworks.github.io/hifir) |
6+
37
## Introduction ##
48

59
Welcome to the `HIFIR` package! `HIFIR` stands for `H`ybrid `I`ncomplete `F`actorization with `I`terative `R`efinement, which is a *multilevel* preconditioner for ill-conditioned and (nearly) singular systems. `HIFIR` has (near) linear time complexity in its factorization and solve and is robust due to its multilevel structure, scalability-oriented dropping, and careful control of the condition numbers of the triangular factors.
610

7-
![HIFIR](https://github.com/hifirworks/hifir/actions/workflows/github-actions.yml/badge.svg?branch=main)
8-
911
## Installation ##
1012

1113
To download the latest version of the code, use the command
14+
1215
```console
13-
git clone -–depth 1 https://github.com/hifirworks/hifir.git hifir
16+
git clone -b release -–depth 1 https://github.com/hifirworks/hifir.git hifir
1417
```
1518

19+
Use `git pull` to download any new changes that have been added since `git clone` or last `git pull`. Alternatively, use `git checkout v[GLOBAL].[MAJOR].[MINOR]` to download a specific version.
20+
21+
Another way is to download the current archive at [v0.1.0](https://github.com/hifirworks/hifir/releases/tag/v0.1.0).
22+
1623
The C++ interface of `HIFIR` is header-only. To install the code, you can simply do the following on a UNIX system
1724

1825
```console
@@ -24,6 +31,7 @@ or copy `/path/to/hifir/src/*` to any user-level directory, for example,
2431
```console
2532
cp -r /path/to/hifir/src/* $HOME/.local/include
2633
```
34+
2735
and then add `-I$HOME/.local/include` to the command line of your `C++` compiler.
2836

2937
## Copyright and Licenses ##

docs/doxygen/Doxyfile.cfg

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -795,6 +795,7 @@ INPUT = \
795795
../../src \
796796
./contents/main.doc \
797797
./contents/install.doc \
798+
../../CHANGELOG.md \
798799
./contents/params.doc \
799800
./contents/examples.doc \
800801
./defgroups.doc \

docs/doxygen/contents/install.doc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,16 @@ straightforward.
1919
To download the latest version of the code, use the command
2020
2121
\code{.sh}
22-
git clone -–depth 1 https://github.com/hifirworks/hifir.git hifir
22+
git clone -b release -–depth 1 https://github.com/hifirworks/hifir.git hifir
2323
cd hifir
2424
\endcode
2525
26+
Use `git pull` to download any new changes that have been added
27+
since `git clone` or last `git pull`. Alternatively,
28+
use `git checkout v[GLOBAL].[MAJOR].[MINOR]` to download a specific version.
29+
Another way is to download the current archive at
30+
<a href="https://github.com/hifirworks/hifir/releases/tag/v0.1.0">v0.1.0</a>.
31+
2632
To install the code, you can simply do the following on a UNIX system
2733
2834
\code{.sh}

0 commit comments

Comments
 (0)