Merge pull request #107 from frankwswang/dev

0.5-Doc Dev

Project.toml

@@ -1,6 +1,6 @@
 name = "Quiqbox"
 uuid = "7cb8c394-fae1-4ab9-92f2-30189d7746cd"
-version = "0.5.0"
+version = "0.5.1"
 
 [deps]
 Combinatorics = "861a8166-3701-5b0c-9a16-15d98fcdc6aa"

README.md

@@ -24,13 +24,13 @@
 
 ## OS (64-bit) support
 * Generic Linux
-* MacOS
+* macOS
 * Windows
 
-**NOTE:** Each operating system (OS) platform is only tested on x86 architecture. The support of those systems on different architectures (such as MacOS on ARM architecture) is not guaranteed.
+**NOTE:** Each operating system (OS) platform is only tested on the x86-64 architecture. The support of those systems on different architectures (such as MacOS on ARM architecture) is not guaranteed.
 
 ## Julia (64-bit) compatibility
-Quiqbox will always try to support the [latest released version](https://julialang.org/downloads/#current_stable_release) of 64-bit Julia as soon as possible. On the other hand, the backward compatibility with previous versions is not guaranteed but can be checked [here](https://github.com/frankwswang/Quiqbox.jl/actions/workflows/CI-JS-older.yml).
+Quiqbox will always try to support the [latest stable release](https://julialang.org/downloads/#current_stable_release) of 64-bit Julia as soon as possible. On the other hand, backward compatibility with previous versions is not guaranteed but can be checked [here](https://github.com/frankwswang/Quiqbox.jl/actions/workflows/CI-JS-older.yml).
 
 ## Installation in Julia [REPL](https://docs.julialang.org/en/v1/manual/getting-started/)
 
@@ -46,7 +46,7 @@ Type the following command and hit *Enter* key to install Quiqbox:
 (@v1.x) pkg> add Quiqbox
 ```
 
-After the installation completes, hit *Backspace* key to go back to the Julian mode and use [`using`](https://docs.julialang.org/en/v1/base/base/#using) to load Quiqbox:
+After the installation completes, hit the *Backspace* key to go back to the Julian mode and use [`using`](https://docs.julialang.org/en/v1/base/base/#using) to load Quiqbox:
 
 ```julia
 julia> using Quiqbox
@@ -85,8 +85,7 @@ optimizeParams!(pars, bs, nuc, coords)
 ```
 
 # Documentation
-
-For more information on the package, please read the [documentation of the latest release][Doc-stable]. For unreleased/experimental features, please refer to the [development documentation][Doc-latest].
+Functions directly exported to the user in Quiqbox have the corresponding docstring that can be accessed through the [Help mode](https://docs.julialang.org/en/v1/stdlib/REPL/#Help-mode) in Julia REPL. The [latest release's documentation][Doc-stable] has all the docstrings and additional tutorials of the package. For unreleased/experimental features, please refer to the [developer documentation][Doc-latest].
 
 <br />
 <br />

docs/src/index.md

@@ -14,13 +14,13 @@
 
 ### OS (64-bit) support
 * Generic Linux
-* MacOS
+* macOS
 * Windows
 
-**NOTE:** Each operating system (OS) platform is only tested on x86 architecture. The support of those systems on different architectures (such as MacOS on ARM architecture) is not guaranteed.
+**NOTE:** Each operating system (OS) platform is only tested on the x86-64 architecture. The support of those systems on different architectures (such as MacOS on ARM architecture) is not guaranteed.
 
 ### Julia (64-bit) compatibility
-Quiqbox will always try to support the [latest released version](https://julialang.org/downloads/#current_stable_release) of 64-bit Julia as soon as possible. On the other hand, the backward compatibility with previous versions is not guaranteed but can be checked [here](https://github.com/frankwswang/Quiqbox.jl/actions/workflows/CI-JS-older.yml).
+Quiqbox will always try to support the [latest stable release](https://julialang.org/downloads/#current_stable_release) of 64-bit Julia as soon as possible. On the other hand, backward compatibility with previous versions is not guaranteed but can be checked [here](https://github.com/frankwswang/Quiqbox.jl/actions/workflows/CI-JS-older.yml).
 
 ### Installation in Julia [REPL](https://docs.julialang.org/en/v1/manual/getting-started/)
 
@@ -36,7 +36,7 @@ Type the following command and hit *Enter* key to install Quiqbox:
 (@v1.x) pkg> add Quiqbox
 ```
 
-After the installation completes, hit *Backspace* key to go back to the Julian mode and use [`using`](https://docs.julialang.org/en/v1/base/base/#using) to load Quiqbox:
+After the installation completes, hit the *Backspace* key to go back to the Julian mode and use [`using`](https://docs.julialang.org/en/v1/base/base/#using) to load Quiqbox:
 
 ```julia
 julia> using Quiqbox