Skip to content

Commit 72a31b6

Browse files
committed
refine docs
1 parent dedc25e commit 72a31b6

File tree

6 files changed

+57
-24
lines changed

6 files changed

+57
-24
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ copier copy --trust https://github.com/fluent-qa/fluentqa-pytpl.git my-project
1111
- create project by pdm
1212

1313
```sh
14-
mkdir my-project && cd my-project
14+
mkdir my-project && cd my-project
1515
pdm init https://github.com/fluent-qa/fluentqa-pytpl.git
1616
```
1717

@@ -20,7 +20,7 @@ pdm init https://github.com/fluent-qa/fluentqa-pytpl.git
2020
- [PDM](https://pdm.fming.dev/)
2121
- [PDM 中文文档](https://pdm.fming.dev/zh_CN/latest/index.html)
2222

23-
## Templates
23+
## Templates References
2424

2525
templates:
2626
- https://github.com/serious-scaffold/ss-python.git
@@ -30,4 +30,3 @@ templates:
3030
- https://github.com/zillionare/cookiecutter-pypackage.git
3131
- https://github.com/rnag/cookiecutter-pypackage.git
3232
- https://github.com/yxtay/python-project-template.git
33-

assets/images/coverage.svg

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/advanced/.keepit

Whitespace-only changes.

docs/concepts/.keepit

Whitespace-only changes.

docs/index.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,57 @@
11
# Index
22

3+
Quick Introduction for PDM Pythong Depencincy Manager,and how to use pdm to init project from a github repo.
4+
5+
## PDM
6+
7+
- [PDM](./pdm/0-setup.md) PDM setup
8+
- [PDM](./pdm/1-dependencies.md) PDM depenencies management
9+
- [PDM](./pdm/2-pdm-script.md) PDM scripts
10+
11+
## Init Project Quickstart
12+
Two ways to create a new python project:
13+
14+
- create project by copier:
15+
16+
```sh
17+
copier copy --trust https://github.com/fluent-qa/fluentqa-pytpl.git my-project
18+
```
19+
20+
- create project by pdm
21+
22+
```sh
23+
mkdir my-project && cd my-project
24+
pdm init https://github.com/fluent-qa/fluentqa-pytpl.git
25+
```
26+
27+
Two ways to create a new python project:
28+
29+
- create project by copier:
30+
31+
```sh
32+
copier copy --trust https://github.com/fluent-qa/fluentqa-pytpl.git my-project
33+
```
34+
35+
- create project by pdm
36+
37+
```sh
38+
mkdir my-project && cd my-project
39+
pdm init https://github.com/fluent-qa/fluentqa-pytpl.git
40+
```
41+
42+
43+
## PDM as Pythong Depencincy Manager
44+
45+
- [PDM](https://pdm.fming.dev/)
46+
- [PDM 中文文档](https://pdm.fming.dev/zh_CN/latest/index.html)
47+
48+
## Templates References
49+
50+
templates:
51+
- https://github.com/serious-scaffold/ss-python.git
52+
- https://github.com/TezRomacH/python-package-template.git
53+
- https://github.com/leynier/python-template.git
54+
- https://github.com/fpgmaas/cookiecutter-poetry.git
55+
- https://github.com/zillionare/cookiecutter-pypackage.git
56+
- https://github.com/rnag/cookiecutter-pypackage.git
57+
- https://github.com/yxtay/python-project-template.git
File renamed without changes.

0 commit comments

Comments
 (0)