mitmproxy/docs/README.md
Maximilian Hils 05a43572c8 make development setup instructions more clear
Our dev.sh/dev.ps1 scripts feel like an unnecessary layer of abstraction.
The revised docs make the install process transparent to experienced users,
and can also be easily reused for other projects (hi, pdoc!).
2021-01-18 13:56:27 +01:00

23 lines
658 B
Markdown

# Mitmproxy Documentation
This directory houses the mitmproxy documentation available at <https://docs.mitmproxy.org/>.
## Quick Start
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.
Now you can run `hugo server -D` in ./src.
## Extended Install
This is required to modify CSS files.
1. Install "extended" hugo version.
You can now run `modd` in this directory instead of running hugo directly.