aboutsummaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2019-11-15 17:24:59 +0100
committerGitHub <noreply@github.com>2019-11-15 17:24:59 +0100
commit50443df3404e660984c5bbfd999dc96d0bc9b1b2 (patch)
tree58a1636284b7a933b7c483531723f780f77e6efc /docs/README.md
parent3eebfed79f4d54840a054c2dc5061e155c416d3e (diff)
parentf6f9eb2c4e022cd44ccc39b3f61fdf31cbfea793 (diff)
downloadmitmproxy-50443df3404e660984c5bbfd999dc96d0bc9b1b2.tar.gz
mitmproxy-50443df3404e660984c5bbfd999dc96d0bc9b1b2.tar.bz2
mitmproxy-50443df3404e660984c5bbfd999dc96d0bc9b1b2.zip
Merge branch 'master' into master
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md
index cc06f081..a9ee1113 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -7,7 +7,8 @@ This directory houses the mitmproxy documentation available at <https://docs.mit
1. Install [hugo](https://gohugo.io/).
2. Windows users: Depending on your git settings, you may need to manually create a symlink from
/docs/src/examples to /examples.
-
+ 3. Make sure the mitmproxy Python package is installed.
+ 4. Run `./build-current` to generate the documentation source files in `./src/generated`.
Now you can run `hugo server -D` in ./src.