We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 46e0735 commit c2fba0fCopy full SHA for c2fba0f
1 file changed
README.md
@@ -3,10 +3,17 @@
3
A Python script to idempotently download, extract, and locally serve a mirror of
4
[docs.python.org](https://docs.python.org/).
5
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.
+## Installation and usage
9
10
-**Platforms?** Assumes Linux with `curl` and `tar` available for now.
+The script uses only the standard library and `requests`, so in most
+environments (e.g. Ubuntu) you can just run the script in your shell:
11
12
-**Why not use `pydoc -b`?** The color scheme.
+```
+./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