Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update windows install guide #452

Merged
merged 1 commit into from
Apr 27, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/Beginner's-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,26 @@ $ npm install -g --production

Check [bcoin-docker](https://github.com/bcoin-org/bcoin-docker)

### Installing on Windows

Install OpenSSL v1.0.2L 64-Bit:

https://slproweb.com/download/Win64OpenSSL-1_0_2L.exe

As Administrator, open `cmd.exe` and run:

```console
C:\Users\bcoin\bcoin>npm install --global --production windows-build-tool
```

to install `VCBuild.exe` and `Python 2.7.x` both required by `node-gyp`
for building native modules.

Then continue [Installing via Git](#installing-via-git)

Note that you need a shell that supports bash scripts, like Git Bash to launch
bcoin.

### Troubleshooting

If the build fails compilation for `bcoin-native` or `secp256k1-node` __validation will be slow__ (a block verification which should take 1 second on consumer grade hardware may take up to 15 seconds). Bcoin will throw a warning on boot if it detects a build failure. If you run into this issue, please post an issue on the repo.
Expand Down