From c3031f3f5e4902bac59a8517576273ebc06cf1e3 Mon Sep 17 00:00:00 2001 From: foufrix Date: Wed, 13 Nov 2024 12:33:21 +0100 Subject: [PATCH] Update README with further installation notice in case of errors Add npm i -g @mapbox/node-pre-gyp info for Mac and Windows users. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 665ede48e..aed4a046c 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,14 @@ de2f8:ultralight Started JSON RPC Server address=http://localhost:8545 This will start a single instance of the Ultralight client running locally. +### Error related to `node-gyp` or `bcrypto.node` + +For Mac and Windows users, you need to add `npm i -g @mapbox/node-pre-gyp` for the package to work, as our main dependencies rely on `bcrypto`. + +For Mac users, you may need to run `sudo xcodebuild -license` and accept it, as `node-gyp` relies on Xcode commands. + +Clone and install from scratch `ultralight` after that. + ## Connecting to the devnet (developer testnet) 1. Change active folder: `cd packages/cli`