From 231c8eefe386e15cdc1ba5b7a8fc7e193dc6c372 Mon Sep 17 00:00:00 2001 From: Alexander Prinzhorn Date: Fri, 4 Jun 2021 11:14:11 +0200 Subject: [PATCH] Update README.md (#4620) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Document Cookie header folding issues * plural: *exists*, me: 😮 * link list * Update README.md * fair well modd * minor wording fix Co-authored-by: Maximilian Hils --- docs/README.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/docs/README.md b/docs/README.md index 22bf6d61b..c58f64e3a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,20 +2,13 @@ This directory houses the mitmproxy documentation available at . -## Quick Start +## Prerequisites 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 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. + 2. Windows users: Depending on your git settings, you may need to manually create a symlink from `/docs/src/examples` to `/examples`. -Now you can run `hugo server -D` in ./src. +## Editing docs locally -## 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. + 1. Make sure the mitmproxy Python package is installed and the virtual python environment was activated. See [CONTRIBUTING.md](../CONTRIBUTING.md#development-setup) for details. + 2. Run `./build.py` to generate additional documentation source files. + 3. Now you can change your working directory to `./src` and run `hugo server -D`.