Skip to content

Commit 3906d0b

Browse files
committed
docs: add more instructions to readme
1 parent b2fabf5 commit 3906d0b

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ change. A [devenv](https://devenv.sh/) development shell is provided so you can
5454
directly execute `meson`, `ninja`, and take advantage of incremental
5555
compilation.
5656

57+
> [!IMPORTANT]
58+
> It is highly recommended that you use the methods described below if you are
59+
> going to be hacking (developing) on the code. Directly invoking `ninja`
60+
> vastly speeds up subsequent compile times, since Nix cannot take advantage of
61+
> incremental compilation.
62+
5763
Follow the instructions to install `nix` as detailed above, then run
5864

5965
```bash
@@ -94,10 +100,19 @@ ninja
94100

95101
This will produce the `WebSocketWithOpenCV` binary.
96102

103+
> [!IMPORTANT]
104+
> If you add new libraries to Nix and `meson.build`, it is likely you will have
105+
> to `rm -rf` the build directory and regenerate it with the commands above,
106+
> due to some quirks with the Nix environment.
107+
>
108+
> Additionally, you should `exit` the `nix develop` shell and re-run `nix
109+
> develop --impure` if you modify any `nix` files.
110+
97111
## Solution without package managers, only Meson
98112

99-
This approach is not recommended and should only be used if Nix is strictly not
100-
available for whatever reason.
113+
> [!WARNING]
114+
> This approach is not recommended and should only be used if Nix is strictly not
115+
> available for whatever reason.
101116
102117
Before setting up this project, ensure that the following libraries and tools
103118
are installed on your system:

0 commit comments

Comments
 (0)