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

Merge pull request #4560 from jannst/update_contribution_readme 

docs: add more precise instructions on docs setup
This commit is contained in:
Maximilian Hils 2021-04-21 12:06:26 +02:00 committed by GitHub
parent d568881a4d f1a925642f
commit e7fd050523
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

@ -4,10 +4,10 @@ This directory houses the mitmproxy documentation available at <https://docs.mit
## Quick Start
1. Install [hugo](https://gohugo.io/).
1. Install [hugo "extended"](https://gohugo.io/getting-started/installing/).
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. See [CONTRIBUTING.md](../CONTRIBUTING.md#development-setup) for details.
3. Make sure the mitmproxy Python package is installed and the virtual python environment was activated. 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.