Merge pull request #11 from eile/master

Release preparations
Eyescale · Nov 2, 2015 · dffb04b · dffb04b
2 parents e813e22 + b8cfff0
commit dffb04b
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 170 deletions.
diff --git a/.gitexternals b/.gitexternals
@@ -1,2 +1,2 @@
 # -*- mode: cmake -*-
-# CMake/common https://github.com/Eyescale/CMake.git 4b328e4
+# CMake/common https://github.com/Eyescale/CMake.git b158c68
diff --git a/.gitsubprojects b/.gitsubprojects
@@ -1,2 +1,2 @@
 # -*- mode: cmake -*-
-git_subproject(Lunchbox https://github.com/Eyescale/Lunchbox.git 33546f1)
+git_subproject(Lunchbox https://github.com/Eyescale/Lunchbox.git 01caa15)
diff --git a/AUTHORS.txt b/AUTHORS.txt
diff --git a/CMake/PressionCPack.cmake → CMake/CPackConfig.cmake b/CMake/PressionCPack.cmake → CMake/CPackConfig.cmake
@@ -5,13 +5,8 @@
 mark_as_advanced(PRESSION_PACKAGE_VERSION)
 
 set(CPACK_PACKAGE_VENDOR "www.eyescale.ch")
-set(CPACK_PACKAGE_CONTACT "Stefan Eilemann <[email protected]>")
-set(CPACK_PACKAGE_LICENSE "LGPL")
-#set(CPACK_PACKAGE_DESCRIPTION_FILE ${PROJECT_SOURCE_DIR}/doc/RelNotes.md)
-#set(CPACK_RESOURCE_FILE_README ${PROJECT_SOURCE_DIR}/doc/RelNotes.md)
 
-set(CPACK_DEBIAN_PACKAGE_DEPENDS
-  "libstdc++6, libturbojpeg")
+set(CPACK_DEBIAN_PACKAGE_DEPENDS "libstdc++6, libturbojpeg")
 
 set(CPACK_MACPORTS_CATEGORY devel)
 set(CPACK_MACPORTS_DEPENDS Lunchbox)

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -10,14 +10,16 @@ list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/CMake
 include(GitExternal)
 
 set(VERSION_MAJOR "1")
-set(VERSION_MINOR "0")
+set(VERSION_MINOR "1")
 set(VERSION_PATCH "0")
-set(VERSION_ABI 1)
+set(VERSION_ABI 2)
 
 set(GITTARGETS_RELEASE_BRANCH minor)
 set(DPUT_HOST "ppa:eilemann/equalizer-dev")
 
 set(PRESSION_DESCRIPTION "Compressor, decompressor, uploader and downloader plugins")
+set(PRESSION_MAINTAINER "Stefan Eilemann <[email protected]>")
+set(PRESSION_LICENSE LGPL)
 set(COMMON_PROJECT_DOMAIN ch.eyescale)
 
 include(Common)
@@ -47,7 +49,7 @@ 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(PressionCPack)
+include(CPackConfig)
 
 set(CTEST_CUSTOM_WARNING_EXCEPTION ${CTEST_CUSTOM_WARNING_EXCEPTION}
   # http://public.kitware.com/Bug/view.php?id=10179

diff --git a/README.md b/README.md
@@ -3,13 +3,13 @@
 # Introduction {#Introduction}
 
 Welcome to Pression, a C++ library for implementing and loading
-compression and CPU-GPU data transfer plugins
+compression and CPU-GPU data transfer plugins.
 
 The
-[API documentation](http://eyescale.github.io/Pression-1.0/index.html) can be
+[API documentation](http://eyescale.github.io/Pression-1.1/index.html) can be
 found on [eyescale.github.io](http://eyescale.github.io/). As with any open
 source project, the available source code, in particular the
-[unit tests](https://github.com/Eyescale/Pression/tree/1.0/tests) provide a
+[unit tests](https://github.com/Eyescale/Pression/tree/1.1/tests) provide a
 reference for developing applications.
 
 Technical questions can be posted to the Equalizer
@@ -22,6 +22,15 @@ available from [Eyescale](http://www.eyescale.ch). Please contact
 [[email protected]](mailto:[email protected]?subject=Pression%20support)
 for further information.
 
+# Features {#Features}
+
+Pression provides the following major features:
+
+* Compression and CPU-GPU transfer plugin handling: pression::Compressor,
+  pression::Decompressor, pression::Downloader, pression::Plugin,
+  pression::PluginRegistry, pression::Uploader
+* Detailed @ref Changelog
+
 # Building {#Building}
 
 Pression is a cross-platform library, designed to run on any modern
@@ -33,17 +42,11 @@ environment. The following platforms and build environments are tested:
 * Windows: 7 (Visual Studio 2012)
 * Mac OS X: 10.8 (Makefile, Ninja)
 
-~~~
-git clone https://github.com/Eyescale/Pression.git
-cd Pression
-mkdir build
-cd build
-cmake ..
-make
-~~~
-
-# Changes {#Changes}
+Building from source is as simple as:
 
-## Version 1.0 {#Version10}
 
-* Initial release as a separate project from Lunchbox
+    git clone https://github.com/Eyescale/Pression.git
+    mkdir Pression/build
+    cd Pression/build
+    cmake ..
+    make
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
@@ -1,5 +1,5 @@
 
 # Copyright (c) 2012 Stefan Eilemann <[email protected]>
 
-install(FILES RelNotes.md ../AUTHORS.txt ../ACKNOWLEDGEMENTS.txt ../LGPL.txt
-  ../LICENSE.txt DESTINATION ${DOC_DIR} COMPONENT doc)
+install(FILES ../ACKNOWLEDGEMENTS.txt ../LGPL.txt ../LICENSE.txt
+  DESTINATION ${DOC_DIR} COMPONENT doc)
diff --git a/doc/Changelog.md b/doc/Changelog.md
@@ -0,0 +1,10 @@
+# Changelog {#Changelog}
+
+
+# Version 1.1 (2-Nov-2015)
+
+* Removed dependency to boost
+
+# Version 1.0 (8-Jul-2015)
+
+* Initial release as a separate project from Lunchbox
diff --git a/doc/RelNotes.md b/doc/RelNotes.md
diff --git a/pression/types.h b/pression/types.h
@@ -15,20 +15,6 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-/** @mainpage Pression API Documentation
- *
- * Welcome to Pression, a C++ library serving several plugins for compressing
- * CPU and GPU data. Pression provides the following functionality:
- *
- * - Compression and CPU-GPU transfer plugin handling: pression::Compressor,
- *   pression::Decompressor, pression::Downloader, pression::Plugin,
- *   pression::PluginRegistry, pression::Uploader
- *
- * @ref RelNotes
- * <br><a class="el" href="CoverageReport/index.html">Test Code Coverage
- * Report</a> (may be missing from documentation)
- */
-
 #ifndef PRESSION_TYPES_H
 #define PRESSION_TYPES_H