Skip to content

Commit 95f65f5

Browse files
docs(readme): improve script and grammar
1 parent ce95073 commit 95f65f5

File tree

1 file changed

+31
-9
lines changed

1 file changed

+31
-9
lines changed

README.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
## Quick Start
1010

11-
Greet name:
11+
Greet a name:
1212

1313
```sh
1414
pipx run python_cli_template --name world
@@ -19,16 +19,14 @@ pipx run python_cli_template --name world
1919
- [Python](https://www.python.org/)
2020
- [pipx](https://pipx.pypa.io/)
2121

22-
## Install
22+
## CLI
2323

24-
[Python](https://pypi.org/project/python_cli_template/):
24+
Install the CLI:
2525

2626
```sh
2727
pipx install python_cli_template
2828
```
2929

30-
## CLI
31-
3230
### `--name`
3331

3432
**Optional**: Name to greet. Defaults to `World`.
@@ -39,21 +37,39 @@ python_cli_template --name Alex
3937

4038
### `--version`
4139

42-
Show program's version number and exit:
40+
Show the program's version number and exit:
4341

4442
```sh
4543
python_cli_template --version # python_cli_template -v
4644
```
4745

48-
Show help message and exit:
46+
Show the help message and exit:
4947

5048
```sh
5149
python_cli_template --help # python_cli_template -h
5250
```
5351

54-
## Package
52+
## Script
53+
54+
Create a virtual environment:
55+
56+
```sh
57+
python3 -m venv .venv
58+
```
59+
60+
Activate the virtual environment:
5561

56-
Greet name:
62+
```sh
63+
source .venv/bin/activate
64+
```
65+
66+
Install the package:
67+
68+
```sh
69+
pip install python_cli_template
70+
```
71+
72+
Greet a name:
5773

5874
```py
5975
# script.py
@@ -62,6 +78,12 @@ from python_cli_template import hello
6278
print(hello("Bob"))
6379
```
6480

81+
Run the script:
82+
83+
```sh
84+
python script.py
85+
```
86+
6587
## License
6688

6789
[MIT](https://github.com/remarkablemark/python_cli_template/blob/master/LICENSE)

0 commit comments

Comments
 (0)