Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Documentation updated

  • Loading branch information...
commit bc9ead23e2cbe2bcc520559a1f46f5aea265996c 1 parent bfc69ab
@saleyn saleyn authored
Showing with 18 additions and 20 deletions.
  1. +1 −1  README
  2. +1 −2  src/Makefile.in
  3. +16 −17 src/overview.edoc
View
2  README
@@ -4,7 +4,7 @@ Building
The bindings work against the master branch of ZeroMQ:
http://github.com/sustrik/zeromq2
- $ git clone git@github.com:zeromq/erlzmq.git erlzmq
+ $ git clone git@github.com:zeromq/erlzmq.git
$ cd erlzmq
$ ./bootstrap
$ ./configure --with-zeromq=/path/to/zeromq
View
3  src/Makefile.in
@@ -10,8 +10,7 @@ ERL_SOURCES=$(wildcard *.erl)
EBIN_DIR=../ebin
DOC_DIR=../doc
ERL_OBJECTS=$(ERL_SOURCES:%.erl=$(EBIN_DIR)/%.beam)
-DOC_FILES=$(addprefix $(DOC_DIR)/,index.html modules-frame.html \
- overview-summary.html stylesheet.css zmq.html)
+DOC_FILES=$(addprefix $(DOC_DIR)/,zmq.html)
all: $(ERL_OBJECTS)
View
33 src/overview.edoc
@@ -34,36 +34,33 @@ ZeroMQ project is found here: [http://zeromq.org]
Project location and git origin:
<ul>
-<li>[http://github.com/saleyn/erlzmq]</li>
-<li>`git clone git://github.com/saleyn/erlzmq.git'</li>
+<li>[http://github.com/zeromq/erlzmq]</li>
+<li>`git clone git@github.com:zeromq/erlzmq.git'</li>
</ul>
== Building ==
This implementation requires a feature of ZeroMQ that is
-not yet included in the 2.0.6 release, and therefore ZeroMQ needs
-to be patched by applying the `zeromq-2.0.6.poll.patch' patch.
+not yet included in the main 2.0.7 repository, and therefore
+needs a version of ZeroMQ from Sustrik's repository:
+
+[http://github.com/sustrik/zeromq2]
```
- # Get erlzmq and 0MQ projects
+ # Get and build 0MQ project
$ cd /tmp
- $ git clone git://github.com/sustrik/zeromq2.git
- $ git clone git://github.com/saleyn/erlzmq.git
+ $ git clone git://github.com/sustrik/zeromq2.git zeromq
- # Patch ZeroMQ
-
- $ cp erlzmq/patches/zeromq-2.0.6.poll.patch /tmp/zeromq2/
- $ cd /tmp/zeromq2
- $ patch -p0 < zeromq-2.0.6.poll.patch
- $ ./configure --with-pgm --prefix=/opt/zeromq-2.0.6
+ $ cd zeromq
+ $ ./configure --with-pgm --prefix=/opt/zeromq-2.0.7
$ make
$ make install
'''
Erlzmq project comes with a bootstrap script that uses autotools to creare a
configure script. Below are the steps needed to build erlzmq given the location
-of ZeroMQ installation being `/opt/zeromq-2.0.6':
+of ZeroMQ installation being `/opt/zeromq-2.0.7':
Make sure that Erlang is installed and `erl' is in the `PATH'. If it's not
in the path, specify `--with-erlang=PATH' option for the configure script.
@@ -71,21 +68,23 @@ in the path, specify `--with-erlang=PATH' option for the configure script.
Run:
```
+ $ cd /tmp
+ $ git clone git@github.com:zeromq/erlzmq.git
$ cd /tmp/erlzmq
$ ./bootstrap
- $ ./configure --with-zeromq=/opt/zeromq-2.0.6
+ $ ./configure --with-zeromq=/opt/zeromq-2.0.7
$ make
$ make docs
'''
== Issue Tracking ==
-[http://github.com/saleyn/erlzmq/issues]
+[http://github.com/zeromq/erlzmq/issues]
== Contributing ==
When you make any changes to documentation, run the following script to
-update documentation on the [http://saleyn.github.com/erlzmq] site:
+update documentation on the [http://zeromq.github.com/erlzmq] site:
```
$ make gitdocs
Please sign in to comment.
Something went wrong with that request. Please try again.