Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 83 lines (55 sloc) 3.773 kB
895ef58 Fixed image link
Pieter Hintjens authored
1 .set GIT=https://github.com/imatix/zguide
3737962 @hintjens Moved README to gitdown syntax
hintjens authored
2 .sub 0MQ=ØMQ
3
4 0MQ - The Guide
5 ===============
6
fbf4b0e @hintjens Minor changes
hintjens authored
7 Written by Pieter Hintjens <ph@imatix.com>, CEO iMatix Corporation.
8
847130d @hintjens Examples now distinguish translated from absent
hintjens authored
9 A 0MQ socket is what you get when you take a normal TCP socket, inject it with a mix of radioactive isotopes stolen from a secret Soviet atomic research project, bombard it with 1950-era cosmic rays, and put it into the hands of a drug-addled comic book author with a badly-disguised fetish for bulging muscles clad in spandex. Yes, 0MQ sockets are the world-saving superheros of the networking world.
10
11 [diagram]
12 +------------+ +------------+
13 | | | | Zap!
14 | TCP socket +------->| 0MQ socket |
15 | | BOOM! | cC00 | POW!!
16 +------------+ +------------+
17 ^ ^ ^
18 | | |
19 | | \---------\
20 | | |
21 | \----------\ |
22 Illegal | |
23 radioisotopes | |
24 from secret | |
25 Soviet atomic | Spandex
26 city |
27 Cosmic rays
28
29
30 A terrible accident...
31 [/diagram]
32
9df1c9e @hintjens Added horizontal TOC
hintjens authored
33 Contents
34 --------
35
36 .toc 1
3737962 @hintjens Moved README to gitdown syntax
hintjens authored
37
38 License
07c9a3b @hintjens Clarified how to submit patches
hintjens authored
39 -------
40
3737962 @hintjens Moved README to gitdown syntax
hintjens authored
41 The text of "0MQ - The Guide" is copyright (c) 2010 Pieter Hintjens, and is licensed under the Creative Commons Attribution-Share Alike 3.0 License. The source code examples are licensed under MIT/X11. `z2w` is placed into the public domain.
42
43 Thanks
44 ------
07c9a3b @hintjens Clarified how to submit patches
hintjens authored
45
8a9663c @hintjens Fixes to the text
hintjens authored
46 Thanks to Bill Desmarais, Brian Dorsey, CAF, Daniel Lin, Eric Desgranges, Gonzalo Diethelm, Guido Goldstein, Hunter Ford, Kamil Shakirov, Martin Sustrik, Mike Castleman, Naveen Chawla, Nicola Peduzzi, Oliver Smith, Olivier Chamoux, Peter Alexander, Pierre Rouleau, Randy Dryburgh, and Zed Shaw for their contributions, and to Stathis Sideris for [Ditaa](ditaa.org).
07c9a3b @hintjens Clarified how to submit patches
hintjens authored
47
3737962 @hintjens Moved README to gitdown syntax
hintjens authored
48 General
49 -------
50
51 The Guide is a general introduction to 0MQ, and covers version 2.0.x. It will be updated to cover 2.1.0 as soon as that is formally released.
52
7e57924 @hintjens Fixed links
hintjens authored
53 To submit an errata use the [issue tracker](http://github.com/imatix/zguide/issues). All discussion of the contents or examples happens on the zeromq-dev list or #zeromq IRC channel.
07c9a3b @hintjens Clarified how to submit patches
hintjens authored
54
55 Examples
56 --------
57
3737962 @hintjens Moved README to gitdown syntax
hintjens authored
58 The examples from the Guide help people to learn and use 0MQ. While we wrote most of the examples in C, we welcome translations into other languages. All example code is licensed under MIT/X11.
07c9a3b @hintjens Clarified how to submit patches
hintjens authored
59
c1e96e6 @hintjens Updated contribution policy
hintjens authored
60 Languages with a 100% translation of examples get their own version of the Guide. So far, only the PHP community have managed this. To send us a translation, please clone this git and make a pull request, following the process explained here: <http://www.zeromq.org/docs:contributing>.
07c9a3b @hintjens Clarified how to submit patches
hintjens authored
61
c1e96e6 @hintjens Updated contribution policy
hintjens authored
62 If you don't want to use git, you can email us entire examples but only if the code was empty before. If you want to update or change an example you MUST use git pull requests.
07c9a3b @hintjens Clarified how to submit patches
hintjens authored
63
64 Guidelines
65 ----------
66
67 Please:
68
3737962 @hintjens Moved README to gitdown syntax
hintjens authored
69 * Stick to identical functionality and naming used in examples so that readers can easily compare languages.
07c9a3b @hintjens Clarified how to submit patches
hintjens authored
70 * You MUST place your name as author in the examples so readers can contact you.
3737962 @hintjens Moved README to gitdown syntax
hintjens authored
71 * You MUST state in the email that you license your code under the MIT/X11 license, or else use git's signoff feature as explained on this page: http://www.zeromq.org/docs:contributing
07c9a3b @hintjens Clarified how to submit patches
hintjens authored
72
73 Thanks!
74
3737962 @hintjens Moved README to gitdown syntax
hintjens authored
75 Build Process
76 -------------
77
fbf4b0e @hintjens Minor changes
hintjens authored
78 To rebuild the Guide from this git repository you need z2w and Ditaa (included in the bin directory), ImageMagick, perl. Run the command: "z2w chapter*.txt". The result is a series of files named `chapter1.wd`, `chapter2.wd`, etc. Paste these into a Wikidot site appropriately.
3737962 @hintjens Moved README to gitdown syntax
hintjens authored
79
80 Images and source examples are hosted here at github.com and to modify an image or example we commit it to this repository.
07c9a3b @hintjens Clarified how to submit patches
hintjens authored
81
7e57924 @hintjens Fixed links
hintjens authored
82 This document is originally at README.txt and is built using [gitdown](http://github.com/imatix/gitdown), a great little tool by the same author.
Something went wrong with that request. Please try again.