Commit 57a37544 authored by Mathis Rosenhauer's avatar Mathis Rosenhauer

Documentation update.

parent 7885ec21
v0.3
More efficient coding of second extension if reference
sample is present.
Port library to Windows (Visual Studio).
Support building with CMake.
......
......@@ -2,7 +2,8 @@
Installation
============
The most common installation procedure looks as follows.
The most common installation procedure on Unix-like systems looks as
follows.
Unpack the tar archive and change into the unpacked directory.
......@@ -25,3 +26,12 @@ On a 3.4 GHz E3-1240 v3 we see more than 400 MiB/s for encoding
typical data.
Using other SIMD instruction sets on older CPUs may also help.
=======
Windows
=======
As an alternative way to build libaec you can use CMake. CMake can
also generate project files for Microsoft Visual Studio. This allows
you to build AEC.DLL and SZIP.DLL which can be used with the Windows
version of HDF5.
ACLOCAL_AMFLAGS = -I m4
SUBDIRS = src tests
EXTRA_DIST = doc/license.txt doc/logo.svg CMakeLists.txt cmake/config.h.in \
cmake/macros.cmake
EXTRA_DIST = doc/license.txt CMakeLists.txt cmake/config.h.in \
cmake/macros.cmake README.SZIP
bench: all
cd tests && $(MAKE) $(AM_MAKEFLAGS) bench
......
**********************************************************************
SZIP compatibility
**********************************************************************
Libaec includes a free drop-in replacement for the SZIP
library[1]. Just replace SZIP's shared library libsz.so* with
libaec.so* and libsz.so* from libaec. Code which is dynamically linked
with SZIP such as HDF5 should continue to work without re-compilation.
HDF5 files which contain SZIP encoded data can be decoded by HDF5
using libaec and vice versa.
[1] http://www.hdfgroup.org/doc_resource/SZIP/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment