Skip to content

Commit 506e0c9

Browse files
committed
git info change in docs
1 parent 645639b commit 506e0c9

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

docs/quick_start/easy_install.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
This guide helps you install ABACUS with basic features. **For DeePKS, DeePMD and Libxc support, or building with `make`, please refer to [the advanced installation guide](../advanced/install.md)** after going through this page. We recommend building ABACUS with `cmake` to avoid dependency issues. We recommend compiling ABACUS(and possibly its requirements) from the source code using the latest compiler for the best performace. You can also deploy ABACUS **without building** by [Docker](#container-deployment) or [conda](#install-by-conda). Please note that ABACUS only supports Linux; for Windows users, please consider using [WSL](https://learn.microsoft.com/en-us/windows/wsl/) or docker.
44

5+
## Get ABACUS source code
6+
7+
ABACUS source code can be obtained via one of the following choices:
8+
9+
- Clone the whole repo with git: `git clone https://github.com/deepmodeling/abacus-develop.git`
10+
- Clone the minimum required part of repo: `git clone https://github.com/deepmodeling/abacus-develop.git --depth=1`
11+
- Download the latest source code without git: `wget https://github.com/deepmodeling/abacus-develop/archive/refs/heads/develop.zip`
12+
- Get the source code of a stable version [here](https://github.com/deepmodeling/abacus-develop/releases)
13+
- If you have connection issues accessing GitHub, please try out our official [Gitee repo](https://gitee.com/deepmodeling/abacus-develop/): e.g. `git clone https://gitee.com/deepmodeling/abacus-develop.git`. This Gitee repo is updated synchronously with GitHub.
14+
15+
516
## Prerequisites
617

718
To compile ABACUS, please make sure that the following prerequisites are present:
@@ -52,23 +63,13 @@ Users should read the README in toolchain directory for most of the information
5263
> Notice: the toolchain is under development, please let we know if you encounter any problem in using this toolchain by raising issue or contacting us.
5364
5465

55-
## Get ABACUS source code
56-
57-
Of course a copy of ABACUS source code is required, which can be obtained via one of the following choices:
58-
59-
- Clone the whole repo with git: `git clone https://github.com/deepmodeling/abacus-develop.git`
60-
- Clone the minimum required part of repo: `git clone https://github.com/deepmodeling/abacus-develop.git --depth=1`
61-
- Download the latest source code without git: `wget https://github.com/deepmodeling/abacus-develop/archive/refs/heads/develop.zip`
62-
- Get the source code of a stable version [here](https://github.com/deepmodeling/abacus-develop/releases)
63-
- If you have connection issues accessing GitHub, please try out our official [Gitee repo](https://gitee.com/deepmodeling/abacus-develop/): e.g. `git clone https://gitee.com/deepmodeling/abacus-develop.git`
64-
65-
### Update to latest release
66+
## Update to latest release by git
6667

6768
Please check the [release page](https://github.com/deepmodeling/abacus-develop/releases) for the release note of a new version.
6869

6970
It is OK to download the new source code from beginning following the previous step.
7071

71-
To update your cloned git repo in-place:
72+
You can update your cloned git repo (from Github or Gitee) in-place with the following commands:
7273

7374
```bash
7475
git remote -v
@@ -78,7 +79,7 @@ git remote -v
7879

7980
# Replace "origin" with "upstream" or the remote name corresponding to deepmodeling/abacus-develop if necessary
8081
git fetch origin
81-
git checkout v3.2.0 # Replace the tag with the latest version
82+
git checkout v3.8.4 # Replace the tag with the latest version
8283
git describe --tags # Verify if the tag has been successfully checked out
8384
```
8485

0 commit comments

Comments
 (0)