Skip to content

Commit c2fba0f

Browse files
committed
Update README
1 parent 46e0735 commit c2fba0f

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,17 @@
33
A Python script to idempotently download, extract, and locally serve a mirror of
44
[docs.python.org](https://docs.python.org/).
55

6-
**Installation/usage:** It only uses the standard library, so you can just run
7-
`./fetch_python_docs.py --serve` in your shell, or omit `--serve` to only
8-
download.
6+
## Installation and usage
97

10-
**Platforms?** Assumes Linux with `curl` and `tar` available for now.
8+
The script uses only the standard library and `requests`, so in most
9+
environments (e.g. Ubuntu) you can just run the script in your shell:
1110

12-
**Why not use `pydoc -b`?** The color scheme.
11+
```
12+
./fetch_python_docs.py --serve
13+
```
14+
15+
Omit `--serve` to only download and extract.
16+
17+
## Why not just use `pydoc -b`?
18+
19+
The color scheme.

0 commit comments

Comments
 (0)