From caf7a86105ad29a714cb78ca510843926c308b5a Mon Sep 17 00:00:00 2001 From: Arthur Wolf Date: Tue, 15 Nov 2022 10:56:12 +0100 Subject: [PATCH] add note about direnv allow --- docs/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/README.md b/docs/README.md index dbcbe4e9302..4dcfc99fb86 100644 --- a/docs/README.md +++ b/docs/README.md @@ -69,6 +69,14 @@ and Direnv installed. This folder contains another `.envrc` file that adds all the binaries needed to build the docs to `$PATH`. +In short, when you `cd` into this folder, you should see this message: + +```sh +direnv: error wire-server/docs/.envrc is blocked. Run `direnv allow` to approve its content +``` + +Run `direnv allow` to allow the `.envrc` file to modify your environment, and you should then have all the binaries/correct environment needed to build the docs. + ### Generating html output (one-off) ```