Skip to content

Commit

Permalink
Documentation updated for new repository location: zeromq.github.com/…
Browse files Browse the repository at this point in the history
…erlzmq
  • Loading branch information
saleyn committed Jul 24, 2010
1 parent a907ab8 commit e505725
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 20 deletions.
37 changes: 18 additions & 19 deletions overview-summary.html
Expand Up @@ -41,54 +41,53 @@ <h3><a name="Downloading">Downloading</a></h3>

Project location and git origin:
<ul>
<li><a href="http://github.com/saleyn/erlzmq" target="_top"><tt>http://github.com/saleyn/erlzmq</tt></a></li>
<li><code>git clone git://github.com/saleyn/erlzmq.git</code></li>
<li><a href="http://github.com/zeromq/erlzmq" target="_top"><tt>http://github.com/zeromq/erlzmq</tt></a></li>
<li><code>git clone git@github.com:zeromq/erlzmq.git</code></li>
</ul>

<h3><a name="Building">Building</a></h3>

<p>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 <code>zeromq-2.0.6.poll.patch</code> patch.</p>
not yet included in the main 2.0.7 repository, and therefore
needs a version of ZeroMQ from Sustrik's repository:</p>

<pre> # Get erlzmq and 0MQ projects
<p><a href="http://github.com/sustrik/zeromq2" target="_top"><tt>http://github.com/sustrik/zeromq2</tt></a></p>

<pre> # 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 &lt; 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</pre>

<p>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 <code>/opt/zeromq-2.0.6</code>:</p>
of ZeroMQ installation being <code>/opt/zeromq-2.0.7</code>:</p>

<p>Make sure that Erlang is installed and <code>erl</code> is in the <code>PATH</code>. If it's not
in the path, specify <code>--with-erlang=PATH</code> option for the configure script.</p>

<p>Run:</p>

<pre> $ cd /tmp/erlzmq
<pre> $ 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</pre>

<h3><a name="Issue_Tracking">Issue Tracking</a></h3>

<p><a href="http://github.com/saleyn/erlzmq/issues" target="_top"><tt>http://github.com/saleyn/erlzmq/issues</tt></a></p>
<p><a href="http://github.com/zeromq/erlzmq/issues" target="_top"><tt>http://github.com/zeromq/erlzmq/issues</tt></a></p>

<h3><a name="Contributing">Contributing</a></h3>

<p>When you make any changes to documentation, run the following script to
update documentation on the <a href="http://saleyn.github.com/erlzmq" target="_top"><tt>http://saleyn.github.com/erlzmq</tt></a> site:</p>
update documentation on the <a href="http://zeromq.github.com/erlzmq" target="_top"><tt>http://zeromq.github.com/erlzmq</tt></a> site:</p>

<pre> $ make gitdocs</pre>

Expand Down Expand Up @@ -231,6 +230,6 @@ <h3><a name="License">License</a></h3>

<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Jul 24 2010, 14:12:22.</i></p>
<p><i>Generated by EDoc, Jul 24 2010, 14:28:56.</i></p>
</body>
</html>
2 changes: 1 addition & 1 deletion zmq.html
Expand Up @@ -123,6 +123,6 @@ <h3 class="function"><a name="start_link-1">start_link/1</a></h3>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Jul 24 2010, 14:12:22.</i></p>
<p><i>Generated by EDoc, Jul 24 2010, 14:28:56.</i></p>
</body>
</html>

0 comments on commit e505725

Please sign in to comment.