From ebe715e9fa8608944023f972601cd05fb4e454c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lex=20Cabeza=20Romero?= Date: Mon, 11 Sep 2023 18:06:19 +0200 Subject: [PATCH] docs(README): List possible WSL Issue (#1995) * Add disclaimer on WSL building issue to README. * Add bundled nim runtime information to README. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 1510f6f5b9..99b253e965 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,23 @@ For more on how to run `wakunode2`, refer to: - [Run using docker](https://docs.waku.org/guides/nwaku/run-docker) - [Run using docker-compose](https://docs.waku.org/guides/nwaku/run-docker-compose) +#### Issues +##### WSL +If you encounter difficulties building the project on WSL, consider placing the project within WSL's filesystem, avoiding the `/mnt/` directory. + +### Developing + +#### Nim Runtime +This repository is bundled with a Nim runtime that includes the necessary dependencies for the project. + +Before you can utilise the runtime you'll need to build the project, as detailed in a previous section. This will generate a `vendor` directory containing various dependencies, including the `nimbus-build-system` which has the bundled nim runtime. + +After successfully building the project, you may bring the bundled runtime into scope by running: +```bash +source env.sh +``` +If everything went well, your should see your prompt suffixed with `[Nimbus env]$`. Now you can run `nim` commands as usual. + ### Waku Protocol Test Suite ```bash