1
- Introduction
2
- ============
1
+ # Introduction
3
2
4
- Library / Bindings
5
- ------------------
3
+ ## Library / Bindings
6
4
7
5
This C++ binding for 0mq/zmq is a 'high-level' library that hides most of the
8
6
c-style interface core 0mq provides. It consists of a number of header and
@@ -16,23 +14,20 @@ both shared and static libraries.
16
14
There are a number of unit tests covering the code but in no way should the
17
15
tests be considered complete.
18
16
19
- Command-Line Client
20
- -------------------
17
+ ## Command-Line Client
21
18
22
19
There is also a command line client that can be used to test or even bridge
23
20
zmq connections. The client is built on top of the libzmqpp bindings.
24
21
25
- Feature Requests
26
- ================
22
+ # Feature Requests
27
23
28
24
If there is any missing features from the current versions of ZeroMQ that you
29
25
wish to use please raise an issue against this project, or even a pull request.
30
26
31
27
Generally I've only added things as I need them but I'm always happy to improve
32
28
the feature set as people require.
33
29
34
- Contributing
35
- ============
30
+ # Contributing
36
31
37
32
Contribution to this binding is welcome and it is suggested using pull requests
38
33
in github that will then be reviewed and merged or commented on. The full
@@ -41,8 +36,7 @@ contribution is outlined on the zmq site (http://zeromq.org/docs:contributing)
41
36
Please feel free to add yourself to the AUTHORS file in an alphanumerically
42
37
sorted way before you raise the pull request.
43
38
44
- Documentation
45
- =============
39
+ # Documentation
46
40
47
41
Most of the code is now commented with doxygen style tags, and a basic
48
42
configuration file to generate them is in the root directory.
@@ -55,8 +49,7 @@ And the resulting html or latex docs will be in the docs/html or docs/latex
55
49
directories.
56
50
57
51
58
- libzmqpp
59
- ========
52
+ # libzmqpp
60
53
61
54
There is a Makefile provided which will build, test and install the binding on
62
55
a GNU Linux system. I have not tested it on anything other than Ubuntu since
@@ -69,17 +62,15 @@ The tests for the binding (make check) require the boost unittest framework to
69
62
have been installed however these do not need to be built or run to install
70
63
the library itself.
71
64
72
- Requirements
73
- ------------
65
+ ## Requirements
74
66
75
67
ZeroMQ 2.2.x or later. We recommend to use ZeroMQ >= 3.
76
68
C++11 compliant compiler. (g++ >= 4.7)
77
69
78
70
The command line client and the tests also require libboost.
79
71
80
72
81
- Installation
82
- ------------
73
+ ## Installation
83
74
84
75
Installation can be done by the standard make && make install. If the boost
85
76
unittest framework is installed, check and installcheck can be run for sanity
@@ -115,8 +106,7 @@ used, and PREFIX to change install location. The CXX prefix should be used on
115
106
all targets as the compiler version is used in the build path. PREFIX is only
116
107
relevant for the install target.
117
108
118
- Debugging
119
- ---------
109
+ ## Debugging
120
110
121
111
The makefile defaults to a production ready build, however a debug version can
122
112
be build by passing CONFIG=debug to the make command. In debug mode there is
@@ -125,8 +115,7 @@ not using the installed library the sanity check effect is governed by the
125
115
defining of NDEBUG.
126
116
127
117
128
- zmqpp
129
- =====
118
+ # zmqpp
130
119
131
120
The make file can also build and install a client tool called zmqpp. To build
132
121
this tool add the step;
@@ -136,8 +125,7 @@ this tool add the step;
136
125
Before the install stage. The install target will install the client to the
137
126
binaries directory if it has been built.
138
127
139
- Usage
140
- -----
128
+ ## Usage
141
129
142
130
The client is a command line tool that can be used to listen or send to 0mq
143
131
sockets. Its very basic so don't expect anything clever. zmqpp --help will list
@@ -174,8 +162,7 @@ on the input stream.
174
162
The default flags will allow you to pipe data from one instance of zmqpp to
175
163
another and so bridge between zmq sockets.
176
164
177
- Licensing
178
- =========
165
+ # Licensing
179
166
180
167
Both the library and the associated command line client are released under the
181
168
MPLv2 license.
0 commit comments