Skip to content

Commit 6f83428

Browse files
committed
update README and docs about installation
1 parent 0caa695 commit 6f83428

File tree

2 files changed

+51
-27
lines changed

2 files changed

+51
-27
lines changed

README.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
</a>
1111
<img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/Dengda98/PyFMM">
1212
<img alt="GitHub License" src="https://img.shields.io/github/license/Dengda98/PyFMM">
13+
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/Dengda98/PyFMM/update_version.yml?label=update%20version">
14+
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/Dengda98/PyFMM/publish_pypi.yml?label=pypi%20publish">
15+
1316
</p>
1417

1518

@@ -61,25 +64,33 @@
6164
# 安装 Installation
6265

6366

64-
## For Linux or Mac
65-
要求系统上有`gcc``make`开发工具。安装有两个选择:
66-
+ **不提前下载程序包**
67-
68-
要求你当前环境中有git工具。这样可直接运行
67+
## For Linux or Mac
68+
要求系统上有`gcc``make`开发工具。有多种下载方式:
69+
+ **[PYPI](https://pypi.org/)下载(推荐)**
70+
**最新更新,已将PyFMM程序源码同步到[PYPI](https://pypi.org/),可直接运行:**
6971
```bash
70-
# vx.x.x指代Release中的版本号,建议下载最新稳定版本
71-
pip install -v git+https://github.com/Dengda98/[email protected]
72-
# 若网速不好可改为gitee镜像
73-
# pip install -v git+https://gitee.com/Dengda98/[email protected]
74-
```
72+
pip install -v pyfmm-kit
73+
```
74+
进行安装,-v选项以查看源码的编译进度。各操作平台的wheels后续会逐步支持。
75+
76+
+ 从Github下载安装,安装有两个选择:
77+
+ **不提前下载程序包**
78+
79+
要求你当前环境中有git工具。这样可直接运行
80+
```bash
81+
# vx.x.x指代Release中的版本号,建议下载最新稳定版本
82+
pip install -v git+https://github.com/Dengda98/[email protected]
83+
# 若网速不好可改为gitee镜像
84+
# pip install -v git+https://gitee.com/Dengda98/[email protected]
85+
```
7586

7687

77-
+ **提前下载好程序包**
88+
+ **提前下载好程序包**
7889

79-
注意代码主页更新频繁,**建议在[Release](https://github.com/Dengda98/PyFMM/releases)中下载最新稳定版本**,不推荐clone,不推荐直接下载主分支。在下载解压后,在程序根目录下运行
80-
```bash
81-
pip install -v .
82-
```
90+
注意代码主页更新频繁,**建议在[Release](https://github.com/Dengda98/PyFMM/releases)中下载最新稳定版本**,不推荐clone,不推荐直接下载主分支。在下载解压后,在程序根目录下运行
91+
```bash
92+
pip install -v .
93+
```
8394

8495
这样可安装到你的虚拟环境中。
8596

docs/source/install.rst

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -66,25 +66,38 @@ Makefile位于 :code:`pyfmm/C_extension/Makefile` ,你可以自定义你的编
6666
For Linux or Mac
6767
^^^^^^^^^^^^^^^^^^
6868

69-
要求系统上有 :code:`gcc`,:code:`make` 开发工具。安装有两个选择:
7069

71-
+ **不提前下载程序包**
7270

73-
要求你当前环境中有 :code:`git` 工具。这样可直接运行
71+
要求系统上有 :code:`gcc`,:code:`make` 开发工具。有多种下载方式:
72+
73+
+ **** `PYPI <https://pypi.org/>`_ **下载(推荐)**
74+
75+
**最新更新,已将PyFMM程序源码同步到** `PYPI <https://pypi.org/>`_ **,可直接运行:**
7476
::
77+
78+
pip install -v pyfmm-kit
7579

76-
# vx.x.x指代Release中的版本号,建议下载最新稳定版本
77-
pip install -v git+https://github.com/Dengda98/[email protected]
78-
# 若网速不好可改为gitee镜像
79-
# pip install -v git+https://gitee.com/Dengda98/[email protected]
80+
进行安装,-v选项以查看源码的编译进度。各操作平台的wheels后续会逐步支持。
8081

81-
+ **提前下载好程序包**
82+
+ 从Github下载安装,安装有两个选择:
8283

83-
注意代码主页更新频繁,**建议在** `Release <https://github.com/Dengda98/PyFMM/releases>`_ **中下载最新稳定版本**,
84-
不推荐直接clone,不推荐直接下载主分支。将压缩包解压后,进入目录,直接运行pip安装命令
85-
::
84+
+ **不提前下载程序包**
85+
86+
要求你当前环境中有 :code:`git` 工具。这样可直接运行
87+
::
88+
89+
# vx.x.x指代Release中的版本号,建议下载最新稳定版本
90+
pip install -v git+https://github.com/Dengda98/[email protected]
91+
# 若网速不好可改为gitee镜像
92+
# pip install -v git+https://gitee.com/Dengda98/[email protected]
93+
94+
+ **提前下载好程序包**
95+
96+
注意代码主页更新频繁,**建议在** `Release <https://github.com/Dengda98/PyFMM/releases>`_ **中下载最新稳定版本**,
97+
不推荐直接clone,不推荐直接下载主分支。将压缩包解压后,进入目录,直接运行pip安装命令
98+
::
8699

87-
pip install -v .
100+
pip install -v .
88101

89102

90103
这将完成以上Python库的安装,以及C程序的编译链接。

0 commit comments

Comments
 (0)