From 438567f58c86ab13d721bd34f039fbddea52906f Mon Sep 17 00:00:00 2001
From: aesyondu <57334943+aesyondu@users.noreply.github.com>
Date: Tue, 6 Apr 2021 21:40:13 +0800
Subject: [PATCH] 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 a7d1f32c89f3ea8b989a2d63fac13a44bc34f946

* Update README.md

Co-authored-by: Maximilian Hils <github@maximilianhils.com>
---
 docs/README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/README.md b/docs/README.md
index 9b1efd11b..b0ae7d3e6 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -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.