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

docs(docs-readme): clarify documentation readme (#4538) 

* docs(docs-readme): clarify documentation readme

I was confused what `mitmproxy Python package` meant. At first I did `pipx install mitmproxy`, but that didn't work. Then I realized I needed it as a library/module, not cli.

Changed `build.sh` to `build.py` since it was deleted on commit a7d1f32c89

* Update README.md

Co-authored-by: Maximilian Hils <github@maximilianhils.com>
This commit is contained in:
aesyondu 2021-04-06 21:40:13 +08:00 committed by GitHub
parent 1b0fce6aba
commit 438567f58c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/README.md
View File

@ -7,8 +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.sh` to generate additional documentation source files.
3. Make sure the mitmproxy Python package is installed. See [CONTRIBUTING.md](../CONTRIBUTING.md#development-setup) for details.
4. Run `./build.py` to generate additional documentation source files.
Now you can run `hugo server -D` in ./src.