Skip to content

Commit d73e5fe

Browse files
committed
update docs .
1 parent 2eb22a6 commit d73e5fe

File tree

5 files changed

+7
-6
lines changed

5 files changed

+7
-6
lines changed

API-doc-FORD-file.md

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ project_download: https://github.com/fortran-fans/forlab
2424
favicon: doc/media/favicon.png
2525
license: by-sa
2626
author: FORLAB v1.0 contributors
27+
author_pic: doc/media/Fortran-Fans.png
2728
author_email: [email protected]
2829
github: https://github.com/fortran-fans
2930
dbg: true

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ FORLAB uses [stdlib](https://github.com/fortran-lang/stdlib) as an upstream pack
1515
| **Copyright:** | _This document_ has been placed in the public domain. |
1616
| **License:** | _FORLAB_ is released under the MIT License. |
1717

18-
## Getting Started
18+
## Getting Started ([中文文档](./README_CN.md))
1919
### Get the code
2020

2121
```bash

README_CN.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ FORLAB使用stdlib作为上游包,相比于stdlib,FORLAB是非正式的,
1212
| **版本:** | 1.0.1 |
1313
| **作者:** | FORLAB 贡献者 |
1414
| **源码网页:** | https://github.com/fortran-fans/forlab |
15-
| **API-Doc网页:** | https://zoziha.github.io/forlab-API-doc/ |
15+
| **API-Doc网页:** | https://fortran-fans.github.io/forlab/ |
1616
| **许可证:** | _ORLAB在MIT开源许可证下发行. |
1717

1818
## 开始
@@ -48,15 +48,15 @@ fpm test <test_name, see `fpm.toml` or list>
4848

4949
```toml
5050
[dependencies] # or [dev-dependencies] for tests.
51-
forlab = { git = "https://github.com/fortran-fans/forlab.git" }
51+
forlab = { git="https://github.com/fortran-fans/forlab.git", branch="forlab-fpm" }
5252
```
5353

5454
## API文档
5555

5656
```bash
5757
ford API-doc-FORD-file.md # todo
5858
```
59-
see [forlab-API-doc](https://zoziha.github.io/forlab-API-doc/).
59+
see [forlab-API-doc](https://fortran-fans.github.io/forlab/).
6060

6161
有一些API使用的例子被放置在了`example`文件夹下,你可以使用FPM来运行它们:
6262

doc/media/Fortran-Fans.png

24.5 KB
Loading

doc/specs/forlab_math.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ is_close(a, b, rel_tol, abs_tol) = is_close(a%re, b%re, rel_tol, abs_tol) .and.
139139

140140
#### Syntax
141141

142-
`bool = [[stdlib_math(module):is_close(interface)]] (a, b [, rel_tol, abs_tol])`
142+
`bool = [[forlab_math(module):is_close(interface)]] (a, b [, rel_tol, abs_tol])`
143143

144144
#### Status
145145

@@ -193,7 +193,7 @@ Returns a boolean scalar where two arrays are element-wise equal within a tolera
193193

194194
#### Syntax
195195

196-
`bool = [[stdlib_math(module):all_close(interface)]] (a, b [, rel_tol, abs_tol])`
196+
`bool = [[forlab_math(module):all_close(interface)]] (a, b [, rel_tol, abs_tol])`
197197

198198
#### Status
199199

0 commit comments

Comments
 (0)