Skip to content

Commit 1d0862b

Browse files
committed
chore: Add instructions for using system versions of zeromq.
1 parent 1c308ee commit 1d0862b

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,27 @@
2929
```shell
3030
git clone https://github.com/microsoft/vscode-jupyter
3131
cd vscode-jupyter
32+
33+
```
34+
35+
On Apple Silicon, you will have to use system versions of `libsodium` and `libzmq` instead of the bundled ones:
36+
37+
```shell
38+
brew update
39+
brew install cmake pkg-config libsodium zeromq
40+
41+
export CMAKE_POLICY_VERSION_MINIMUM=3.5
42+
export PKG_CONFIG_PATH="$(brew --prefix)/lib/pkgconfig"
43+
export CPPFLAGS="-I$(brew --prefix libsodium)/include -I$(brew --prefix zeromq)/include"
44+
export LDFLAGS="-L$(brew --prefix libsodium)/lib -L$(brew --prefix zeromq)/lib"
45+
46+
npm_config_build_from_source=true npm install zeromq@^6.0.0-beta.16
47+
48+
```
49+
50+
Install the dependecies:
51+
52+
```shell
3253
npm ci
3354
# Run this to setup the necessary pre-commit hooks.
3455
npm run setup-precommit-hook
@@ -39,6 +60,7 @@ source .venv/bin/activate
3960
.venv\Scripts\activate
4061
# The Python code in the extension is formatted using Black.
4162
python -m pip install black
63+
4264
```
4365

4466
### Incremental Build
@@ -49,6 +71,7 @@ You can also compile from the command-line. For a full compile you can use:
4971

5072
```shell
5173
npm run compile
74+
5275
```
5376

5477
For incremental builds it is recommended you use the `watch` build task (for better integration with VS Code).

0 commit comments

Comments
 (0)