Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Reformat README.md for reasonable line length

  • Loading branch information...
commit 4b17cb0c6593f93a97365ba976e80464ed709694 1 parent 30249a3
@ericbmerritt ericbmerritt authored
Showing with 19 additions and 9 deletions.
  1. +19 −9 README.md
View
28 README.md
@@ -7,13 +7,14 @@ Copyright (c) 2011 Yurii Rashkovskii, Evax Software and Michael Truog
Overview
========
-The erlzmq2 application provides high-performance NIF based Erlang bindings
-for the ZeroMQ messaging library.
+The erlzmq2 application provides high-performance NIF based Erlang
+bindings for the ZeroMQ messaging library.
Downloading
===========
-The erlzmq2 source code can be found on [GitHub](https://github.com/yrashk/erlzmq2)
+The erlzmq2 source code can be found on
+[GitHub](https://github.com/yrashk/erlzmq2)
$ git clone http://github.com/zeromq/erlzmq2.git
@@ -21,7 +22,8 @@ It is also available on [Agner](http://erlagner.org/):
$ agner build erlzmq
-In order to build erlzmq2 against a specific version of ZeroMQ (not `v2.1.11`), use this:
+In order to build erlzmq2 against a specific version of ZeroMQ (not
+`v2.1.11`), use this:
$ ZEROMQ_VERSION=v<VERSION> agner build erlzmq
@@ -32,7 +34,8 @@ Build the code
$ make
-If you want to build against a specific version of ZeroMQ (not `v2.1.11`), use this:
+If you want to build against a specific version of ZeroMQ (not
+`v2.1.11`), use this:
$ ZEROMQ_VERSION=v<VERSION> make
@@ -44,18 +47,25 @@ Run the test suite
$ make test
-Run the benchmarks (requires [python](http://www.python.org) and [matplotlib](http://matplotlib.sourceforge.net/))
+Run the benchmarks (requires [python](http://www.python.org) and
+[matplotlib](http://matplotlib.sourceforge.net/))
$ make bench
-This will run performance tests and output png graphs in the graphs directory.
+This will run performance tests and output png graphs in the graphs
+directory.
-Please note that to behave properly on your system ZeroMQ might require [some tuning](http://www.zeromq.org/docs:tuning-zeromq).
+Please note that to behave properly on your system ZeroMQ might
+require [some tuning](http://www.zeromq.org/docs:tuning-zeromq).
Architecture
============
-The bindings use Erlang's [NIF (native implemented functions)](http://www.erlang.org/doc/man/erl_nif.html) interface to achieve the best performance. One extra OS thread and one pair of inproc sockets by context are used to simulate blocking recv calls without affecting the Erlang virtual machine's responsiveness.
+The bindings use Erlang's
+[NIF (native implemented functions)](http://www.erlang.org/doc/man/erl_nif.html)
+interface to achieve the best performance. One extra OS thread and one
+pair of inproc sockets by context are used to simulate blocking recv
+calls without affecting the Erlang virtual machine's responsiveness.
License
=======
Please sign in to comment.
Something went wrong with that request. Please try again.