Updated overview and created documentation update script

overview-summary.html

@@ -11,24 +11,41 @@ <h1>Erlang bindings for ZeroMQ messaging framework.
 </h1>
 <p>Copyright © 2010 Serge Aleynikov and Dhammika Pathirana
 </p>
-<p><b>Version:</b> May 26 2010 08:57:23
+<p><b>Version:</b> May 26 2010 11:06:18
 </p>
 <p><b>Authors:</b> Serge Aleynikov (<a href="mailto:saleyn at gmail dot com"><tt>saleyn at gmail dot com</tt></a>), Dhammika Pathirana (<a href="mailto:dhammika at gmail dot com"><tt>dhammika at gmail dot com</tt></a>).</p>
 
 
+<ol>
+<li><a href="#Building">Building</a></li>
+<li><a href="#Issue_Tracking">Issue Tracking</a></li>
+<li><a href="#Architecture">Architecture</a></li>
+<li><a href="#Known_Limitations">Known Limitations</a></li>
+<li><a href="#Usage">Usage</a></li>
+</ol>
+
 <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>
 
-<pre>  $ cp patches/zeromq-2.0.6.poll.patch /path/to/zeromq/source/
-  $ cd /path/to/zeromq/source/
+<pre>  # Get erlzmq and 0MQ projects
+
+  $ cd /tmp
+  $ git clone git://github.com/sustrik/zeromq2.git
+  $ git clone git://github.com/saleyn/erlzmq.git
+
+  # 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
   $ make
   $ make install</pre>
 
-<p>After applying the patch modify the path in <code>c_src/Makefile</code> 
+<p>After applying the patch to ZeroMQ modify the path in <code>/tmp/erlzmq/c_src/Makefile</code> 
 of the following variable to reflect location of ZeroMQ installation:</p>
 
 <pre>ZMQ_DIR=/opt/zeromq-2.0.6</pre>
@@ -37,9 +54,14 @@ <h3><a name="Building">Building</a></h3>
 
 <p>Run:</p>
 
-<pre>  $ make
+<pre>  $ cd /tmp/erlzmq
+  $ make
   $ make docs</pre>
 
+<h3><a name="Issue_Tracking">Issue Tracking</a></h3>
+
+<p><a href="http://www.zeromq.org/bindings:erlang" target="_top"><tt>http://www.zeromq.org/bindings:erlang</tt></a></p>
+
 <h3><a name="Architecture">Architecture</a></h3>
 
 <p>A ZeroMQ context is created by calling zmq:start_link/0 or
@@ -83,7 +105,7 @@ <h3><a name="Architecture">Architecture</a></h3>
 
 <p>zmq:send/2 and zmq:recv/1 calls may block the owner Erlang process
 but will never block the Erlang VM.  The driver uses non-blocking
-calls to <code>zmq_send(2)</code> and <code>zmq_recv(1)</code> functions and will not
+calls to <code>zmq_send(3)</code> and <code>zmq_recv(3)</code> functions and will not
 deliver any result to the caller's pid until the message is 
 successfully sent or received.  Currently timeout option is not
 implemented on these two calls.</p>
@@ -172,6 +194,6 @@ <h4><a name="Sample_ZMQ_REP_server">Sample ZMQ_REP server</a></h4>
 
 <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, May 26 2010, 08:57:23.</i></p>
+<p><i>Generated by EDoc, May 26 2010, 11:06:18.</i></p>
 </body>
 </html>

update

@@ -0,0 +1,8 @@
+#!/bin/sh
+git checkout master src vsn.mk
+cd src
+make docs
+cd ..
+rm -fr src vsn.mk
+mv doc/* .
+rmdir doc

zmq.html

@@ -122,6 +122,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, May 26 2010, 08:57:23.</i></p>
+<p><i>Generated by EDoc, May 26 2010, 11:06:18.</i></p>
 </body>
 </html>