Separte changelog from documentation, use README.md as main page

CMakeLists.txt

@@ -15,8 +15,7 @@ set(VERSION_MINOR "6")
 set(VERSION_PATCH "1")
 set(VERSION_ABI 1)
 
-set(DEFLECT_DESCRIPTION
-  "The client library to write applications for DisplayCluster")
+set(DEFLECT_DESCRIPTION "A fast C++ library for streaming pixels and events")
 set(DEFLECT_DEPENDENT_LIBRARIES Boost)
 
 include(Common)
@@ -29,8 +28,9 @@ add_subdirectory(apps)
 add_subdirectory(tests)
 add_subdirectory(doc)
 
+set(DOXYGEN_MAINPAGE_MD README.md)
+set(DOXYGEN_EXTRA_INPUT ${PROJECT_SOURCE_DIR}/README.md)
 include(DoxygenRule) # must be after all targets
-include(PackageConfig)
 
 set(CTEST_CUSTOM_WARNING_EXCEPTION ${CTEST_CUSTOM_WARNING_EXCEPTION}
   # http://public.kitware.com/Bug/view.php?id=10179

README.md

@@ -1,21 +1,49 @@
 # Deflect
 
-Welcome to Deflect, a C++ library for building applications to stream pixels
-to DisplayCluster.
+Welcome to Deflect, a C++ library for streaming pixels to other Deflect-based
+applications, for example
+[DisplayCluster](https://github.com/BlueBrain/DisplayCluster).
+Deflect offers a stable API marked with version 1.0 (for the client part).
 
 ## Features
 
 Deflect provides the following functionality:
-* Stream pixels to a DisplayCluster instance
-* Register for receiving events from a DisplayCluster instance
-* DesktopStreamer, an application to stream the desktop to DisplayCluster
+
+* Stream pixels to a remote Server from one or multiple sources
+* Register for receiving events from the Server
+* Compressed or uncompressed streaming
+* Fast multi-threaded JPEG compression (using libjpeg-turbo)
+
+The following applications are provided which make use of the streaming API:
+
+* DesktopStreamer: A small utility that lets you stream your desktop.
+* SimpleStreamer: A simple example to demonstrate streaming of an OpenGL
+  application.
 
 ## Building from source
 
-```
+~~~
   git clone https://github.com/BlueBrain/Deflect.git
   mkdir Deflect/build
   cd Deflect/build
   cmake ..
   make
-```
+~~~
+
+## ChangeLog
+
+To keep track of the changes between releases check the
+[changelog](doc/Changelog.md).
+
+## About
+
+Deflect is a cross-platform library, designed to run on any modern operating
+system, including all Unix variants. Deflect uses CMake to create a
+platform-specific build environment. The following platforms and build
+environments are tested:
+
+* Linux: Ubuntu 14.04 and RHEL 6 (Makefile, x64)
+* Mac OS X: 10.7 - 10.10 (Makefile, x86_64)
+
+The [latest API documentation](http://bluebrain.github.io/Deflect-0.6/index.html)
+can be found on [bluebrain.github.io](http://bluebrain.github.io).

doc/CMakeLists.txt

@@ -1,5 +1,5 @@
 
 # Copyright (c) 2015 Daniel Nachbaur <[email protected]>
 
-install(FILES RelNotes.md ../LGPL.txt ../LICENSE.txt DESTINATION ${DOC_DIR}
+install(FILES Changelog.md ../LGPL.txt ../LICENSE.txt DESTINATION ${DOC_DIR}
         COMPONENT doc)

doc/RelNotes.md → doc/Changelog.md

@@ -1,36 +1,21 @@
-Release Notes {#mainpage}
+Changelog {#Changelog}
 ============
 
-[TOC]
-
-# Introduction {#Introduction}
-
-Welcome to Deflect, a C++ library to develop applications that can send
-and receive pixel streams from other Deflect-based applications, for
-example DisplayCluster. Deflect offers a stable API marked with version
-1.0 for the streaming part. The following applications are provided
-which make use of the streaming API:
-
-* DesktopStreamer: A small utility that lets you stream your desktop.
-* SimpleStreamer: A simple example to demonstrate streaming of an OpenGL
-  application.
-
-Please file a [Bug Report](https://github.com/BlueBrain/Deflect/issues)
-if you find any other issue with this release.
-
-# Changes {#Changes}
-
 ## Deflect 0.6
 
-* Many classes of the Server part have been renamed
-* Various API fixes
-* Project-wide codestyle cleanup
+### 0.6.1 (13-07-2015)
 * DesktopStreamer: Minor fixes for desktop interaction, only show checkbox on
   supported platforms (OSX)
 * DesktopStreamer OSX: zip the application for Puppet deployment
 
+### 0.6.0 (28-06-2015)
+* Many classes of the Server part have been renamed
+* Various API fixes
+* Project-wide codestyle cleanup
+
 ## Deflect 0.5
 
+### 0.5.1 (12-05-2015)
 * Streamers can register for events immediately, without waiting for the
   DisplayCluster host to have opened a window
 * Desktopstreamer supports autodiscovery of DisplayCluster hosts using Zeroconf
@@ -39,6 +24,9 @@ if you find any other issue with this release.
 
 ## Deflect 0.4
 
+### 0.4.1 (24-04-2015)
 * DesktopStreamer properly handles AppNap on OSX 10.9.
 * DesktopStreamer detects Retina displays automatically (no retina checkbox).
+
+### 0.4.0 (07-01-2015)
 * First release, based on the DisplayCluster 0.4 dcStream library