Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation updates for post QUICK-24.03 release #365

Merged
merged 1 commit into from
Apr 28, 2024
Merged

Documentation updates for post QUICK-24.03 release #365

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<p align="right">
<img src="https://github.com/Madu86/QUICK/workflows/Serial%20Build/badge.svg">
<img src="https://github.com/Madu86/QUICK/workflows/MPI%20Build/badge.svg">
<img src='https://readthedocs.org/projects/quick-docs/badge/?version=24.3.0' alt='Documentation Status' />
<img src='https://readthedocs.org/projects/quick-docs/badge/?version=latest' alt='Documentation Status' />
</p>
<p align="left">
<img width="299" height="169" src="./tools/logo.png">
Expand Down Expand Up @@ -42,20 +42,20 @@ Installation
------------
Supported platforms: Linux (x86 and ARM), macOS (x86 and ARM)

* [Installation Guide](https://quick-docs.readthedocs.io/en/24.3.0/installation-guide.html#installation-guide)
1. [Compatible Compilers and Hardware](https://quick-docs.readthedocs.io/en/24.3.0/installation-guide.html#compatible-compilers-and-hardware)
2. [Installation](https://quick-docs.readthedocs.io/en/24.3.0/installation-guide.html#installation)
3. [Testing](https://quick-docs.readthedocs.io/en/24.3.0/installation-guide.html#environment-variables-and-testing)
4. [Uninstallation](https://quick-docs.readthedocs.io/en/24.3.0/installation-guide.html#uninstallation-and-cleaning)
* [Installation Guide](https://quick-docs.readthedocs.io/en/latest/installation-guide.html#installation-guide)
1. [Compatible Compilers and Hardware](https://quick-docs.readthedocs.io/en/latest/installation-guide.html#compatible-compilers-and-hardware)
2. [Installation](https://quick-docs.readthedocs.io/en/latest/installation-guide.html#installation)
3. [Testing](https://quick-docs.readthedocs.io/en/latest/installation-guide.html#environment-variables-and-testing)
4. [Uninstallation](https://quick-docs.readthedocs.io/en/latest/installation-guide.html#uninstallation-and-cleaning)

Getting Started
---------------
* [Hands-on Tutorials](https://quick-docs.readthedocs.io/en/24.3.0/hands-on-tutorials.html)
* [User Manual](https://quick-docs.readthedocs.io/en/24.3.0/user-manual.html)
* [Hands-on Tutorials](https://quick-docs.readthedocs.io/en/latest/hands-on-tutorials.html)
* [User Manual](https://quick-docs.readthedocs.io/en/latest/user-manual.html)

Known Issues
------------
A list of installation and runtime issues can be found [here](https://quick-docs.readthedocs.io/en/24.3.0/known-issues.html#known-issues-of-current-version).
A list of installation and runtime issues can be found [here](https://quick-docs.readthedocs.io/en/latest/known-issues.html#known-issues-of-current-version).

Citation
--------
Expand Down Expand Up @@ -118,7 +118,7 @@ DL-FIND: An Open-Source Geometry Optimizer for Atomistic Simulations.

License
-------
QUICK is licensed under Mozilla Public License 2.0. More information can be found [here](https://quick-docs.readthedocs.io/en/24.3.0/license.html#mozilla-public-license-version-2-0).
QUICK is licensed under Mozilla Public License 2.0. More information can be found [here](https://quick-docs.readthedocs.io/en/latest/license.html#mozilla-public-license-version-2-0).

Special Note to Users
---------------------
Expand Down