Skip to content
This repository was archived by the owner on May 26, 2023. It is now read-only.

Commit 57d647c

Browse files
committed
update readme
1 parent 5cf40ff commit 57d647c

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,23 @@ want to use it for.
2929
| [`@zilliqa-js/util`](./packages/zilliqa-js-util) | Miscellaneous functions that take care of serialisation/deserialisation and validation. | none |
3030
| [`@zilliqa-js/viewblock`](https://github.com/Ashlar/zilliqa-js-viewblock) | Library interfacing with ViewBlock's APIs | `@zilliqa-js/crypto` |
3131

32+
33+
## Pre-Requisite (Windows Users)
34+
35+
`zilliqa-js` uses [`scrypt`](https://www.npmjs.com/package/scrypt) library which depends on `node-gyp` in order to compile the binaries from source on Windows.
36+
`node-gyp` on Windows requires users to install additional Visual Studio Build tools.
37+
38+
To install the required Visual Studio Build tools:
39+
40+
```shell
41+
npm install --global --production windows-build-tools # from an elevated PowerShell or CMD.exe as Administrator
42+
43+
npm config set msvs_version 2015 # 2015 is more compatible; though 2017 may work too
44+
```
45+
46+
Refer to https://github.com/nodejs/node-gyp#installation for more information about `node-gyp` installation on Windows.
47+
48+
3249
## Installation
3350

3451
It is recommended that developers install the JavaScript client by making use

0 commit comments

Comments
 (0)