Skip to content
Browse files

Documentation changes

  • Loading branch information...
1 parent a1c0f29 commit ae908178ce3f7cccdffe19825279fc1977f5a4a4 @saleyn saleyn committed May 28, 2010
Showing with 43 additions and 13 deletions.
  1. +1 −0 .gitignore
  2. +2 −2 Makefile.am
  3. +3 −3 configure.ac
  4. +37 −8 src/overview.edoc
View
1 .gitignore
@@ -12,6 +12,7 @@ config.h
config.h.in
config.log
config.status
+config.cache
configure
ebin/zmq.app
m4/version
View
4 Makefile.am
@@ -5,8 +5,8 @@ TARBALL_EXCLUDE=/tmp/exclude.xxx
SUBDIRS = c_src src
-#docs:
-# @${MAKE} --directory=src $@
+docs:
+ @${MAKE} --directory=src $@
gitdocs: docs
./bin/update_docs
View
6 configure.ac
@@ -141,9 +141,9 @@ dnl ------------------------------------------------------------------
AC_ARG_WITH([zeromq],
AC_HELP_STRING([--with-zeromq=PATH],
- [set PATH to the installation of zeromq library]),
+ [set PATH to the installation of zeromq library [[default=/usr]]]),
[ZEROMQ_LIB=${with_zeromq}],
- [ZEROMQ_LIB=""])
+ [ZEROMQ_LIB="/usr"])
AC_CHECK_HEADER([${ZEROMQ_LIB}/include/zmq.h], [], [
AC_MSG_ERROR([Could not find the 'zmq.h' header.
@@ -173,8 +173,8 @@ AC_MSG_NOTICE([ C++ compiler: ${CXX}])
AC_MSG_NOTICE([ Erlang compiler: ${ERLC}])
AC_MSG_NOTICE([ Erlang erts dir: ${ERLANG_ERTS_DIR}])
AC_MSG_NOTICE([ Erlang erts ver: ${ERLANG_ERTS_VER}])
-AC_MSG_NOTICE([ Erlang lib dir: ${ERLANG_INSTALL_LIB_DIR}])
AC_MSG_NOTICE([ erl_interface: ${ERLANG_LIB_DIR_erl_interface}])
+AC_MSG_NOTICE([ ZeroMQ: ${ZEROMQ_LIB}])
echo
AC_MSG_NOTICE([ Debug/warnings: ${enable_debug}/${enable_warnings}])
View
45 src/overview.edoc
@@ -11,11 +11,14 @@
<ol>
<li>{@section Overview}</li>
+<li>{@section Downloading}</li>
<li>{@section Building}</li>
<li>{@section Issue Tracking}</li>
+<li>{@section Contributing}</li>
<li>{@section Architecture}</li>
<li>{@section Known Limitations}</li>
<li>{@section Usage}</li>
+<li>{@section License}</li>
</ol>
== Overview ==
@@ -27,6 +30,14 @@ ZeroMQ distributed clients that may be written in other languages.
ZeroMQ project is found here: [http://zeromq.org]
+== Downloading ==
+
+Project location and git origin:
+<ul>
+<li>[http://github.com/saleyn/erlzmq]</li>
+<li>`git clone git://github.com/saleyn/erlzmq.git'</li>
+</ul>
+
== Building ==
This implementation requires a feature of ZeroMQ that is
@@ -48,22 +59,21 @@ to be patched by applying the `zeromq-2.0.6.poll.patch' patch.
$ ./configure --with-pgm --prefix=/opt/zeromq-2.0.6
$ make
$ make install
-
'''
-After applying the patch to ZeroMQ modify the path in `/tmp/erlzmq/c_src/Makefile'
-of the following variable to reflect location of ZeroMQ installation:
+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':
-```
-ZMQ_DIR=/opt/zeromq-2.0.6
-'''
-
-Make sure that Erlang is installed and `erl' is in the `PATH'.
+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.
Run:
```
$ cd /tmp/erlzmq
+ $ ./bootstrap
+ $ ./configure --with-zeromq=/opt/zeromq-2.0.6
$ make
$ make docs
'''
@@ -72,6 +82,22 @@ Run:
[http://github.com/saleyn/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:
+
+```
+ $ make gitdocs
+'''
+
+The following make target can be used to do a cleanup of all artifacts
+of make and configure:
+
+```
+ $ make clean-bootstrap
+'''
+
== Architecture ==
A ZeroMQ context is created by calling zmq:start_link/0 or
@@ -207,3 +233,6 @@ by using ^G, or in a separate OS shell:
'''
+== License ==
+
+The project is released under BSD license.

0 comments on commit ae90817

Please sign in to comment.
Something went wrong with that request. Please try again.