Merge pull request #76 from tribal-tec/master

Release 0.3 preparations

.gitexternals

@@ -1,2 +1,2 @@
 # -*- mode: cmake -*-
-# CMake/common https://github.com/Eyescale/CMake.git a9c3537
+# CMake/common https://github.com/Eyescale/CMake.git 2b5d7f2

.gitsubprojects

@@ -1,3 +1,3 @@
 # -*- mode: cmake -*-
-git_subproject(Servus https://github.com/HBPVIS/Servus.git a1a4b29)
+git_subproject(Servus https://github.com/HBPVIS/Servus.git 0e1db45)
 git_subproject(FlatBuffers https://github.com/Bluebrain/flatbuffers.git b5721cf)

CMake/GitExternal.cmake

@@ -67,7 +67,7 @@ function(GIT_EXTERNAL DIR REPO TAG)
     if(NOT OLD_TAG STREQUAL TAG)
       string(REPLACE "${CMAKE_SOURCE_DIR}/" "" PWD
         "${CMAKE_CURRENT_SOURCE_DIR}")
-      message(STATUS "${DIR}: already configured with ${OLD_TAG}, ignoring requested ${TAG} in ${PWD}")
+      git_external_message("${DIR}: already configured with ${OLD_TAG}, ignoring requested ${TAG} in ${PWD}")
       return()
     endif()
   else()
@@ -146,12 +146,12 @@ function(GIT_EXTERNAL DIR REPO TAG)
   # update tag
   git_external_message("git rebase FETCH_HEAD")
   execute_process(COMMAND ${GIT_EXECUTABLE} rebase FETCH_HEAD
-    RESULT_VARIABLE RESULT OUTPUT_VARIABLE OUTPUT ERROR_VARIABLE OUTPUT
+    RESULT_VARIABLE RESULT ERROR_QUIET OUTPUT_QUIET
     WORKING_DIRECTORY "${DIR}")
   if(RESULT)
     message(STATUS "git rebase failed, aborting ${DIR} merge")
     execute_process(COMMAND ${GIT_EXECUTABLE} rebase --abort
-      WORKING_DIRECTORY "${DIR}")
+      WORKING_DIRECTORY "${DIR}" ERROR_QUIET OUTPUT_QUIET)
   endif()
 
   # checkout requested tag

CMakeLists.txt

@@ -24,5 +24,7 @@ add_subdirectory(zeq)
 add_subdirectory(tests)
 add_subdirectory(tools)
 
+set(DOXYGEN_MAINPAGE_MD README.md)
+set(DOXYGEN_EXTRA_INPUT ${PROJECT_SOURCE_DIR}/README.md)
 include(CPackConfig)
 include(DoxygenRule)

README.md

@@ -1,4 +1,43 @@
-ZeroEQ
-======
+[TOC]
 
-A cross-platform C++ library to publish and subscribe for events. Applications can discover each other automatically through the integrated ZeroConf protocol, or through explicit addressing using hostname and port. A defined vocabulary defines semantics for the published events.
+# Introduction {#Introduction}
+
+A cross-platform C++ library to publish and subscribe for events. Applications
+can discover each other automatically through the integrated ZeroConf protocol,
+or through explicit addressing using hostname and port. A defined vocabulary
+defines semantics for the published events.
+
+## Features {#Features}
+
+ZeroEQ provides the following major features:
+
+* Publish events using zeq::Publisher
+* Subscribe to events using zeq::Subscriber
+* Asynchronous, reliable transport using ZMQ
+* Automatic publisher discovery using Zeroconf
+* Serialization of events using flatbuffers
+
+# Building {#Building}
+
+ZeroEQ is a cross-platform toolkit, designed to run on any modern operating
+system, including all Unix variants. ZeroEQ uses CMake to create a
+platform-specific build environment. The following platforms and build
+environments are tested:
+
+* Linux: Ubuntu 14.04, RHEL 6 using gcc 4.8
+* Windows: 8 using Visual Studio 12
+* Mac OS X: 10.9 and 10.10 using clang 6
+
+ZeroEQ requires the following external, pre-installed dependencies:
+
+* ZeroMQ 4.0 or later
+* Boost (tested with 1.54) for unit tests
+
+~~~
+git clone https://github.com/HBPVIS/zeq.git
+cd zeq
+mkdir build
+cd build
+cmake ..
+make
+~~~

doc/Changelog.md

@@ -0,0 +1,28 @@
+# Changelog
+
+# Release 0.3 (07-07-2015) {#Release03}
+
+* [63](https://github.com/HBPVIS/zeq/pull/63):
+  Replace boost by C++11 std equivalents
+* [64](https://github.com/HBPVIS/zeq/pull/64):
+  Allow specification of network announce protocols in Publisher
+* [68](https://github.com/HBPVIS/zeq/pull/68):
+  OPT: Filter messages for registered handlers
+* [69](https://github.com/HBPVIS/zeq/pull/69):
+  Replaced Lunchbox by Servus
+* [74](https://github.com/HBPVIS/zeq/pull/74):
+  Fix exception with broken DNS and zeroconf
+* [75](https://github.com/HBPVIS/zeq/pull/75):
+  Event for frame setting and animation
+
+# Release 0.2 (01-05-2015) {#Release02}
+
+* zeq::connection::Broker and zeq::connection::Service for subscription from a
+  remote publisher.
+* Concurrently dispatch events for multiple zeq::Subscriber and
+  zeq::connection::Broker using shared zeq::Receiver groups.
+
+# Release 0.1 (07-01-2015){#Release01}
+
+* zeq::Publisher, zeq::Subscriber and zeq::Event for publish-subcribe event
+  driven architectures.

doc/DirectBuffer.md

@@ -28,8 +28,8 @@ the following shortcomings:
 * fixed-elem PODs: stored in-order at start of array
 * static arrays: size (8b) + data padded to next 4b in place
 * dynamic arrays/std::vector, std::string:
-** offset (8b), size (8b) stored in place
-** data at offset after all items at 4b boundary
+  * offset (8b), size (8b) stored in place
+  * data at offset after all items at 4b boundary
 * arrays: returned as ptr, iter, copied std::vector
 * getter/setter generated with hard-coded offsets
 * saved in an atomic ptr for concurrent reallocs