generic-library/libzmq
1
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-12 10:33:52 +01:00
Code Issues Projects Releases Wiki Activity
abb0ada5f7
libzmq/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

219 lines
15 KiB
Markdown
Raw Normal View History

Converted README to markdown + added travis build img
2013-07-14 00:55:40 +02:00
# ZeroMQ
Problem: Travis is no longer free for FLOSS projects Solution: switch to Github Actions Travis recently started enforcing credits for OSS projects without any funding. While it is possible to get free credits, it is a manual step that involves contacting customer support via email and asking to add them, every week. While this does not require money, it requires something far scarcer: volunteers time. Drop Travis and migrate to Github Actions.
2021-09-21 18:05:44 +02:00
[![Build Status](https://github.com/zeromq/libzmq/actions/workflows/CI.yaml/badge.svg)](https://github.com/zeromq/libzmq/actions/workflows/CI.yaml)
Problem: libzmq appveyor build status is not visible Solution: Add a travis like badge to the README fixes #1622
2015-10-26 08:59:22 +01:00
[![Build status](https://ci.appveyor.com/api/projects/status/e2ks424yrs1un3wt?svg=true)](https://ci.appveyor.com/project/zeromq/libzmq)
Problem: no coveralls.io badge in README.md Solution: add it
2016-03-13 21:45:49 +01:00
[![Coverage Status](https://coveralls.io/repos/github/zeromq/libzmq/badge.svg?branch=master)](https://coveralls.io/github/zeromq/libzmq?branch=master)
Converted README to markdown + added travis build img
2013-07-14 00:55:40 +02:00
## Welcome
Update README
2010-03-16 16:20:23 +01:00
Fixes to README
2015-06-02 23:44:12 +02:00
The ZeroMQ lightweight messaging kernel is a library which extends the
Update README
2010-03-16 16:20:23 +01:00
standard socket interfaces with features traditionally provided by
Fixes to README
2015-06-02 23:44:12 +02:00
specialised messaging middleware products. ZeroMQ sockets provide an
Update README
2010-03-16 16:20:23 +01:00
abstraction of asynchronous message queues, multiple messaging patterns,
message filtering (subscriptions), seamless access to multiple transport
protocols and more.
Problem: no documentation of supported platforms Solution: add an initial version
2019-02-19 21:31:30 +01:00
## Supported platforms <a name="#platforms"/>
Problem: Android build is hard to understand Solution: Modify the build scripts so the user can specify the platform for which to build, e.g. `./build.sh arm`. This approach originally significantly reduces the parameters which have to be set before running the script. Further the build process is documented in a README now.
2020-02-12 12:14:32 +01:00
Libzmq is mainly written in C++98 with some optional C++11-fragments. For
configuration either autotools or CMake is employed. See below for some lists
Clarify used C++-standard for compilation. (#3793) * Clarify used C++-standard for compilation. * More than a conforming compiler may be necessary to compile the library. Just refer to the list of known "good" platforms below.
2020-01-26 18:50:17 +01:00
of platforms, where libzmq has been successfully compiled on.
Problem: no documentation of supported platforms Solution: add an initial version
2019-02-19 21:31:30 +01:00
### Supported platforms with primary CI
Problem: Android build is hard to understand Solution: Modify the build scripts so the user can specify the platform for which to build, e.g. `./build.sh arm`. This approach originally significantly reduces the parameters which have to be set before running the script. Further the build process is documented in a README now.
2020-02-12 12:14:32 +01:00
| OS and version | Architecture | Compiler and version | Build system | Remarks |
|----------------------------------------|-------------------------|-------------------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------|
Problem: Main documentation refers to Android NDK 24, when 25 is currently in use. Solution: Fix invalid NDK reference.
2022-11-21 12:15:59 +01:00
| Android NDK r25 | arm, arm64, x86, x86_64 | llvm (see NDK) | autotools | DRAFT |
Problem: Android build is hard to understand Solution: Modify the build scripts so the user can specify the platform for which to build, e.g. `./build.sh arm`. This approach originally significantly reduces the parameters which have to be set before running the script. Further the build process is documented in a README now.
2020-02-12 12:14:32 +01:00
| Ubuntu 14.04.5 LTS (trusty) | amd64 | clang 5.0.0 | autotools | STABLE, extras: GSSAPI, PGM, NORM, C++98 mode only |
| Ubuntu 14.04.5 LTS (trusty) | amd64 | gcc 4.8.4 | autotools | STABLE, DRAFT, extras: GSSAPI, PGM, NORM, TIPC, IPV6, also POLLER=poll, POLLER=select, also valgrind and address sanitizer executions |
| Ubuntu 14.04.5 LTS (trusty) | amd64 | gcc 4.8.4 | CMake 3.12.2 | STABLE |
| Windows Server 2012 R2 | x86 | Visual Studio 2008 | CMake 3.12.2 | DRAFT |
| Windows Server 2012 R2 | x86 | Visual Studio 2010 SP1 | CMake 3.12.2 | DRAFT |
| Windows Server 2012 R2 | x86 | Visual Studio 2012 Update 5 | CMake 3.12.2 | DRAFT |
| Windows Server 2012 R2 | x86, amd64 | Visual Studio 2013 Update 5 | CMake 3.12.2 | DRAFT, STABLE (x86 Release only), also POLLER=epoll |
| Windows Server 2012 R2 | x86 | Visual Studio 2015 Update 3 | CMake 3.12.2 | DRAFT |
| Windows Server 2016 | x86 | Visual Studio 2017 15.9.6 | CMake 3.13.3 | DRAFT |
| cygwin 3.0.0 on Windows Server 2012 R2 | amd64 | gcc 7.4.0 | CMake 3.6.2 | DRAFT |
| MSYS2 ? on Windows Server 2012 R2 | amd64 | gcc 6.4.0 | CMake ? | DRAFT |
| Mac OS X 10.13 | amd64 | Xcode 9.4.1, Apple LLVM 9.1.0 | autotools | STABLE, DRAFT |
| Mac OS X 10.13 | amd64 | Xcode 9.4.1, Apple LLVM 9.1.0 | CMake 3.11.4 | DRAFT |
Problem: no documentation of supported platforms Solution: add an initial version
2019-02-19 21:31:30 +01:00
Note: the platforms are regularly updated by the service providers, so this information might get out of date
without any changes on the side of libzmq. For Appveyor, refer to https://www.appveyor.com/updates/ regarding
platform updates. For travis-ci, refer to https://changelog.travis-ci.com/ regarding platform updates.
### Supported platforms with secondary CI
Problem: Tables in README are difficult to read Solution: Re-factor them to look like usual tables
2020-02-12 12:18:17 +01:00
| OS and version | Architecture | Compiler and version | Build system | Remarks |
|------------------------------|----------------------------|----------------------|--------------|---------|
| CentOS 6 | x86, amd64 | ? | autotools | |
| CentOS 7 | amd64 | ? | autotools | |
| Debian 8.0 | x86, amd64 | ? | autotools | |
| Debian 9.0 | ARM64, x86, amd64 | ? | autotools | |
| Fedora 28 | ARM64, ARM32, amd64 | ? | autotools | |
| Fedora 29 | ARM64, ARM32, amd64 | ? | autotools | |
| Fedora Rawhide | ARM64, ARM32, amd64 | ? | autotools | |
| RedHat Enterprise Linux 7 | amd64, ppc64 | ? | autotools | |
| SuSE Linux Enterprise 12 SP4 | ARM64, amd64, ppc64, s390x | ? | autotools | |
| SuSE Linux Enterprise 15 | amd64 | ? | autotools | |
| xUbuntu 12.04 | x86, amd64 | ? | autotools | |
| xUbuntu 14.04 | x86, amd64 | ? | autotools | |
| xUbuntu 16.04 | x86, amd64 | ? | autotools | |
| xUbuntu 18.04 | x86, amd64 | ? | autotools | |
| xUbuntu 18.10 | x86, amd64 | ? | autotools | |
Problem: no documentation of supported platforms Solution: add an initial version
2019-02-19 21:31:30 +01:00
### Supported platforms with known active users
Problem: Android build is hard to understand Solution: Modify the build scripts so the user can specify the platform for which to build, e.g. `./build.sh arm`. This approach originally significantly reduces the parameters which have to be set before running the script. Further the build process is documented in a README now.
2020-02-12 12:14:32 +01:00
At the time of writing, no explicit reports have been available. Please report your experiences by opening a PR
Problem: no documentation of supported platforms Solution: add an initial version
2019-02-19 21:31:30 +01:00
adding an entry or moving an entry from the section below.
Problem: Android build is hard to understand Solution: Modify the build scripts so the user can specify the platform for which to build, e.g. `./build.sh arm`. This approach originally significantly reduces the parameters which have to be set before running the script. Further the build process is documented in a README now.
2020-02-12 12:14:32 +01:00
Under "last report", please name either the SHA1 in case of an unreleased version, or the version number in
Problem: no documentation of supported platforms Solution: add an initial version
2019-02-19 21:31:30 +01:00
case of a released version.
Problem: Tables in README are difficult to read Solution: Re-factor them to look like usual tables
2020-02-12 12:18:17 +01:00
| OS and version | Architecture | Compiler and version | Build system | Last report | Remarks |
|----------------|-------------------|----------------------|--------------|-------------------------|---------|
| Solaris 10 | x86, amd64, sparc | GCC 8.1.0 | CMake | 2019/03/18 | |
| DragonFly BSD | amd64 | gcc 8.3 | autotools | 2018/08/07 git-72854e63 | |
| IBM i | ppc64 | gcc 6.3 | autotools | 2019/10/02 git-25320a3 | |
Fixes tabs
2020-02-24 09:17:02 +01:00
| QNX 7.0 | x86_64 | gcc 5.4.0 | CMake | 4.3.2 | |
add win/arm64 to supported platform list
2021-11-15 15:24:10 +01:00
| Windows 10 | ARM64 | Visual Studio 2019 | CMake | 2021/11/15 git-2375ca8b | |
| Windows 10 | ARM64 | clang | CMake | 2021/11/15 git-2375ca8b | |
Problem: no documentation of supported platforms Solution: add an initial version
2019-02-19 21:31:30 +01:00
### Supported platforms without known active users
Note: this list is incomplete and inaccurate and still needs some work.
Problem: Tables in README are difficult to read Solution: Re-factor them to look like usual tables
2020-02-12 12:18:17 +01:00
| OS and version | Architecture | Compiler and version | Build system | Remarks |
|------------------------|--------------|--------------------------|------------------|---------|
| Any Linux distribution | x86, amd64 | gcc ?+, clang ?+, icc ?+ | autotools, CMake | |
| SunOS, Solaris | x86, amd64 | SunPro | autotools, CMake | |
| GNU/kFreeBSD | ? | ? | autotools, CMake | |
| FreeBSD | ? | ? | autotools, CMake | |
| NetBSD | ? | ? | autotools, CMake | |
| OpenBSD | ? | ? | autotools, CMake | |
| DragonFly BSD | amd64 | gcc 8.3 | autotools, CMake | |
| HP-UX | ? | ? | autotools, CMake | |
| GNU/Hurd | ? | ? | autotools | |
| VxWorks 6.8 | ? | ? | ? | |
| Windows CE | ? | ? | ? | |
| Windows UWP | ? | ? | ? | |
| OpenVMS | ? | ? | ? | |
Problem: no documentation of supported platforms Solution: add an initial version
2019-02-19 21:31:30 +01:00
### Unsupported platforms
Problem: Tables in README are difficult to read Solution: Re-factor them to look like usual tables
2020-02-12 12:18:17 +01:00
| OS and version | Architecture | Compiler and version | Remarks |
|----------------|--------------|----------------------|-------------------------------------------------------------------------|
| QNX 6.3 | ? | gcc 3.3.5 | see #3371, support was added by a user, but not contributed to upstream |
Problem: no documentation of supported platforms Solution: add an initial version
2019-02-19 21:31:30 +01:00
For more details, see [here](SupportedPlatforms.md).
Problem: Android build is hard to understand Solution: Modify the build scripts so the user can specify the platform for which to build, e.g. `./build.sh arm`. This approach originally significantly reduces the parameters which have to be set before running the script. Further the build process is documented in a README now.
2020-02-12 12:14:32 +01:00
For some platforms (Linux, Mac OS X), [prebuilt binary packages are supplied by the ZeroMQ organization](#installation).
Problem: no documentation of supported platforms Solution: add an initial version
2019-02-19 21:31:30 +01:00
For other platforms, you need to [build your own binaries](#build).
## Installation of binary packages <a name="installation"/>
Update README
2010-03-16 16:20:23 +01:00
Problem: packages builds not mentioned in README.md Solution: add brief description and links
2017-08-21 12:09:32 +02:00
### Linux
For Linux users, pre-built binary packages are available for most distributions.
Note that DRAFT APIs can change at any time without warning, pick a STABLE build to
avoid having them enabled.
#### Latest releases
##### DEB
[![OBS release stable](https://img.shields.io/badge/OBS%20master-stable-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Arelease-stable&package=libzmq3-dev)
[![OBS release draft](https://img.shields.io/badge/OBS%20master-draft-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Arelease-draft&package=libzmq3-dev)
##### RPM
[![OBS release stable](https://img.shields.io/badge/OBS%20master-stable-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Arelease-stable&package=zeromq-devel)
[![OBS release draft](https://img.shields.io/badge/OBS%20master-draft-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Arelease-draft&package=zeromq-devel)
#### Bleeding edge packages
##### DEB
[![OBS release stable](https://img.shields.io/badge/OBS%20master-stable-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Agit-stable&package=libzmq3-dev)
[![OBS release draft](https://img.shields.io/badge/OBS%20master-draft-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Agit-draft&package=libzmq3-dev)
##### RPM
[![OBS release stable](https://img.shields.io/badge/OBS%20master-stable-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Agit-stable&package=zeromq-devel)
[![OBS release draft](https://img.shields.io/badge/OBS%20master-draft-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Agit-draft&package=zeromq-devel)
#### Example: Debian 9 latest release, no DRAFT apis
echo "deb http://download.opensuse.org/repositories/network:/messaging:/zeromq:/release-stable/Debian_9.0/ ./" >> /etc/apt/sources.list
wget https://download.opensuse.org/repositories/network:/messaging:/zeromq:/release-stable/Debian_9.0/Release.key -O- | sudo apt-key add
apt-get install libzmq3-dev
### OSX
For OSX users, packages are available via brew.
brew install zeromq
[document] add vcpkg instruction (#4425) * [document] Add vcpkg instruction step
2022-09-16 12:24:11 +02:00
## Installation of package manager <a name="package manager"/>
### vcpkg
vcpkg is a full platform package manager, you can easily install libzmq via vcpkg.
git clone https://github.com/microsoft/vcpkg.git
./bootstrap-vcpkg.bat # For powershell
./bootstrap-vcpkg.sh # For bash
./vcpkg install zeromq
Problem: no documentation of supported platforms Solution: add an initial version
2019-02-19 21:31:30 +01:00
## Build from sources <a name="build"/>
Problem: packages builds not mentioned in README.md Solution: add brief description and links
2017-08-21 12:09:32 +02:00
To build from sources, see the INSTALL file included with the distribution.
Update README
2010-03-16 16:20:23 +01:00
Problem: Android build is hard to understand Solution: Modify the build scripts so the user can specify the platform for which to build, e.g. `./build.sh arm`. This approach originally significantly reduces the parameters which have to be set before running the script. Further the build process is documented in a README now.
2020-02-12 12:14:32 +01:00
### Android
typo fix root README
2020-04-18 11:24:14 +02:00
To build from source, see [README](./builds/android/README.md) file in the
Problem: Android build is hard to understand Solution: Modify the build scripts so the user can specify the platform for which to build, e.g. `./build.sh arm`. This approach originally significantly reduces the parameters which have to be set before running the script. Further the build process is documented in a README now.
2020-02-12 12:14:32 +01:00
android build directory.
Converted README to markdown + added travis build img
2013-07-14 00:55:40 +02:00
## Resources
Update README
2010-03-16 16:20:23 +01:00
Add Git location to README
2010-03-16 17:07:17 +01:00
Extensive documentation is provided with the distribution. Refer to
Fixes to README
2015-06-02 23:44:12 +02:00
doc/zmq.html, or "man zmq" after you have installed libzmq on your system.
Update README
2010-03-16 16:20:23 +01:00
Website: http://www.zeromq.org/
Development mailing list: zeromq-dev@lists.zeromq.org
Announcements mailing list: zeromq-announce@lists.zeromq.org
Project location on github changed in README file Signed-off-by: Martin Sustrik <sustrik@250bpm.com>
2011-04-02 19:32:44 +02:00
Git repository: http://github.com/zeromq/libzmq
Add Git location to README
2010-03-16 17:07:17 +01:00
Fixes to README
2015-06-02 23:44:12 +02:00
ZeroMQ developers can also be found on the IRC channel #zeromq, on the
Problem: README.md does not mention Libera.chat Solution: fix it Closes #4261
2021-09-22 16:56:26 +02:00
Libera Chat network (irc.libera.chat).
Update README
2010-03-16 16:20:23 +01:00
Fixes to README
2015-06-02 23:44:12 +02:00
## License
The project license is specified in COPYING and COPYING.LESSER.
libzmq is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License (LGPL) as published
by the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
As a special exception, the Contributors give you permission to link
this library with independent modules to produce an executable,
regardless of the license terms of these independent modules, and to
copy and distribute the resulting executable under terms of your choice,
provided that you also meet, for each linked independent module, the
terms and conditions of the license of that module. An independent
module is a module which is not derived from or based on this library.
If you modify this library, you must extend this exception to your
version of the library.
libzmq is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.
Problem: C4 process is not easily discoverable. Solution: Add 'Contributing' section to README.md
2018-11-10 12:54:50 +01:00
## Contributing
This project uses [C4(Collective Code Construction Contract)](https://rfc.zeromq.org/spec:42/C4/) process for contributions.
Reference in New Issue Copy Permalink