Rooba
/
mitmproxy
mirror of https://github.com/mitmproxy/mitmproxy.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improve wording

This commit is contained in:
Maximilian Hils 2019-10-13 18:20:38 +02:00 committed by GitHub
parent f580e0ea97
commit 68a7d37d53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/README.md
View File

@ -7,10 +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.
Make sure mitmproxy python package is installed.
Run `./build-current` script in docs folder. If you skip this step, hugo will fail because files in ./src/generated are missing
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.