Skip to content

Commit 6ef6f8f

Browse files
authored
Problem: Markdown header style is hard to parse for a script
Solution: Migrate to the more commonly used hashtag header. The script I'm referring to is part of the zeromq.org website which will grep the Install section from this Markdown file and show it on the website under the download section.
1 parent 7f099a8 commit 6ef6f8f

File tree

1 file changed

+13
-26
lines changed

1 file changed

+13
-26
lines changed

README.md

+13-26
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
Introduction
2-
============
1+
# Introduction
32

4-
Library / Bindings
5-
------------------
3+
## Library / Bindings
64

75
This C++ binding for 0mq/zmq is a 'high-level' library that hides most of the
86
c-style interface core 0mq provides. It consists of a number of header and
@@ -16,23 +14,20 @@ both shared and static libraries.
1614
There are a number of unit tests covering the code but in no way should the
1715
tests be considered complete.
1816

19-
Command-Line Client
20-
-------------------
17+
## Command-Line Client
2118

2219
There is also a command line client that can be used to test or even bridge
2320
zmq connections. The client is built on top of the libzmqpp bindings.
2421

25-
Feature Requests
26-
================
22+
# Feature Requests
2723

2824
If there is any missing features from the current versions of ZeroMQ that you
2925
wish to use please raise an issue against this project, or even a pull request.
3026

3127
Generally I've only added things as I need them but I'm always happy to improve
3228
the feature set as people require.
3329

34-
Contributing
35-
============
30+
# Contributing
3631

3732
Contribution to this binding is welcome and it is suggested using pull requests
3833
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)
4136
Please feel free to add yourself to the AUTHORS file in an alphanumerically
4237
sorted way before you raise the pull request.
4338

44-
Documentation
45-
=============
39+
# Documentation
4640

4741
Most of the code is now commented with doxygen style tags, and a basic
4842
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
5549
directories.
5650

5751

58-
libzmqpp
59-
========
52+
# libzmqpp
6053

6154
There is a Makefile provided which will build, test and install the binding on
6255
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
6962
have been installed however these do not need to be built or run to install
7063
the library itself.
7164

72-
Requirements
73-
------------
65+
## Requirements
7466

7567
ZeroMQ 2.2.x or later. We recommend to use ZeroMQ >= 3.
7668
C++11 compliant compiler. (g++ >= 4.7)
7769

7870
The command line client and the tests also require libboost.
7971

8072

81-
Installation
82-
------------
73+
## Installation
8374

8475
Installation can be done by the standard make && make install. If the boost
8576
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
115106
all targets as the compiler version is used in the build path. PREFIX is only
116107
relevant for the install target.
117108

118-
Debugging
119-
---------
109+
## Debugging
120110

121111
The makefile defaults to a production ready build, however a debug version can
122112
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
125115
defining of NDEBUG.
126116

127117

128-
zmqpp
129-
=====
118+
# zmqpp
130119

131120
The make file can also build and install a client tool called zmqpp. To build
132121
this tool add the step;
@@ -136,8 +125,7 @@ this tool add the step;
136125
Before the install stage. The install target will install the client to the
137126
binaries directory if it has been built.
138127

139-
Usage
140-
-----
128+
## Usage
141129

142130
The client is a command line tool that can be used to listen or send to 0mq
143131
sockets. Its very basic so don't expect anything clever. zmqpp --help will list
@@ -174,8 +162,7 @@ on the input stream.
174162
The default flags will allow you to pipe data from one instance of zmqpp to
175163
another and so bridge between zmq sockets.
176164

177-
Licensing
178-
=========
165+
# Licensing
179166

180167
Both the library and the associated command line client are released under the
181168
MPLv2 license.

0 commit comments

Comments
 (0)