Skip to content

Commit e9575b9

Browse files
authored
Merge pull request #112 from lgeiger/install-instructions
Update install instructions for Electron
2 parents b04f03e + bcabb8b commit e9575b9

File tree

1 file changed

+12
-23
lines changed

1 file changed

+12
-23
lines changed

README.md

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,20 @@ npm install zeromq
4040

4141
Now, prepare to be amazed by the wonders of binaries.
4242

43-
## Installation - From Source
43+
### Rebuilding for Electron
4444

4545
If you want to use `zeromq` inside your [Electron](http://electron.atom.io/) application
46-
or if you are working on a Linux 32-bit system, you have to build `zeromq` from source.
46+
it needs to be rebuild against Electron headers. We ship prebuilt binaries for Electron so you won't need to build `zeromq` from source.
47+
48+
You can rebuild `zeromq` manually by running:
49+
```bash
50+
npm rebuild zeromq --runtime=electron --target=1.4.5
51+
```
52+
Where `target` is your desired Electron version. This will download the correct binary for usage in Electron.
53+
54+
## Installation - From Source
55+
56+
If you are working on a Linux 32-bit system or want to install a developement version, you have to build `zeromq` from source.
4757

4858
### Prerequisites
4959

@@ -81,24 +91,6 @@ Now you can install `zeromq` with the following:
8191
npm install zeromq
8292
```
8393

84-
85-
### Rebuilding for Electron
86-
87-
If you want to use `zeromq` inside your [Electron](http://electron.atom.io/) application
88-
it needs to be rebuild against Electron headers.
89-
90-
We highly recommend [`electron-builder`](https://github.com/electron-userland/electron-builder)
91-
which handles this automatically.
92-
93-
If you don't want to use `electron-builder` you can rebuild `zeromq` manually by running:
94-
```
95-
npm rebuild zeromq --runtime=electron --target=1.4.5 --disturl=https://atom.io/download/atom-shell --build-from-source
96-
```
97-
Where `target` is your desired Electron version.
98-
99-
You can find more information on the [Electron website](http://electron.atom.io/docs/tutorial/using-native-node-modules/).
100-
101-
10294
## Installation - Contributors and Development
10395

10496
To set up `zeromq` for development, fork this repository and
@@ -221,6 +213,3 @@ prebuilds are uploaded, run the following to publish the release:
221213
```bash
222214
npm publish
223215
```
224-
225-
To check if the binaries are packaged correctly, you can push a commit to
226-
[`nteract/zmq-prebuilt-testing`](https://github.com/nteract/zmq-prebuilt-testing).

0 commit comments

Comments
 (0)