Skip to content

Commit ebe715e

Browse files
docs(README): List possible WSL Issue (#1995)
* Add disclaimer on WSL building issue to README. * Add bundled nim runtime information to README.
1 parent e8776fd commit ebe715e

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

+17
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,23 @@ For more on how to run `wakunode2`, refer to:
3535
- [Run using docker](https://docs.waku.org/guides/nwaku/run-docker)
3636
- [Run using docker-compose](https://docs.waku.org/guides/nwaku/run-docker-compose)
3737

38+
#### Issues
39+
##### WSL
40+
If you encounter difficulties building the project on WSL, consider placing the project within WSL's filesystem, avoiding the `/mnt/` directory.
41+
42+
### Developing
43+
44+
#### Nim Runtime
45+
This repository is bundled with a Nim runtime that includes the necessary dependencies for the project.
46+
47+
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.
48+
49+
After successfully building the project, you may bring the bundled runtime into scope by running:
50+
```bash
51+
source env.sh
52+
```
53+
If everything went well, your should see your prompt suffixed with `[Nimbus env]$`. Now you can run `nim` commands as usual.
54+
3855
### Waku Protocol Test Suite
3956

4057
```bash

0 commit comments

Comments
 (0)