aboutsummaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2019-11-15 18:10:42 +0100
committerMaximilian Hils <git@maximilianhils.com>2019-11-15 18:10:42 +0100
commit0873566ff05c02be063f3aa15adecb725342119c (patch)
treea6dcddf0f0c08c9ff9cdd89e1f95196af2ff5a6a /docs/README.md
parentd852f292c9a45de7f45cc8537f2aef217259017e (diff)
parentfbbbbb678e77e3cff5ab35b1fd55e85e875ed3f5 (diff)
downloadmitmproxy-0873566ff05c02be063f3aa15adecb725342119c.tar.gz
mitmproxy-0873566ff05c02be063f3aa15adecb725342119c.tar.bz2
mitmproxy-0873566ff05c02be063f3aa15adecb725342119c.zip
Merge remote-tracking branch 'origin/master' into pr-3448
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.