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
hifirworks · Aug 22, 2021 · 522381f · 522381f
1 parent 30a7cdd
commit 522381f
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,11 @@
+# Changelog #
+
+All notable changes to this project will be documented in this file.
+
+## Release Candidate ##
+
+[Full Changelog](https://github.com/hifirworks/hifir/compare/v0.1.0...HEAD)
+
+## [v0.1.0](https://github.com/hifirworks/hifir/releases/tag/v0.1.0) (2021-08-22) ##
+
+This is the initial official release of the HIFIR package.
diff --git a/README.md b/README.md
@@ -1,18 +1,25 @@
 # Welcome to *HIFIR* Project #
 
+|CI | Documentation |
+|:---: | :---:|
+| ![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) |
+
 ## Introduction ##
 
 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.
 
-![HIFIR](https://github.com/hifirworks/hifir/actions/workflows/github-actions.yml/badge.svg?branch=main)
-
 ## Installation ##
 
 To download the latest version of the code, use the command
+
 ```console
-git clone -–depth 1 https://github.com/hifirworks/hifir.git hifir
+git clone -b release -–depth 1 https://github.com/hifirworks/hifir.git hifir
 ```
 
+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.
+
+Another way is to download the current archive at [v0.1.0](https://github.com/hifirworks/hifir/releases/tag/v0.1.0).
+
 The C++ interface of `HIFIR` is header-only. To install the code, you can simply do the following on a UNIX system
 
 ```console
@@ -24,6 +31,7 @@ or copy `/path/to/hifir/src/*` to any user-level directory, for example,
 ```console
 cp -r /path/to/hifir/src/* $HOME/.local/include
 ```
+
 and then add `-I$HOME/.local/include` to the command line of your `C++` compiler.
 
 ## Copyright and Licenses ##

diff --git a/docs/doxygen/Doxyfile.cfg b/docs/doxygen/Doxyfile.cfg
@@ -795,6 +795,7 @@ INPUT                  = \
   ../../src \
   ./contents/main.doc \
   ./contents/install.doc \
+  ../../CHANGELOG.md \
   ./contents/params.doc \
   ./contents/examples.doc \
   ./defgroups.doc \

diff --git a/docs/doxygen/contents/install.doc b/docs/doxygen/contents/install.doc
@@ -19,10 +19,16 @@ straightforward.
 To download the latest version of the code, use the command
 
 \code{.sh}
-    git clone -–depth 1 https://github.com/hifirworks/hifir.git hifir
+    git clone -b release -–depth 1 https://github.com/hifirworks/hifir.git hifir
     cd hifir
 \endcode
 
+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.
+Another way is to download the current archive at
+<a href="https://github.com/hifirworks/hifir/releases/tag/v0.1.0">v0.1.0</a>.
+
 To install the code, you can simply do the following on a UNIX system
 
 \code{.sh}