Skip to content

Commit

Permalink
Update README with further installation notice in case of errors
Browse files Browse the repository at this point in the history
Add npm i -g @mapbox/node-pre-gyp info for Mac and Windows users.
  • Loading branch information
foufrix authored Nov 13, 2024
1 parent 3af6fbd commit c3031f3
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit c3031f3

Please sign in to comment.