source: trunk/README.txt @ 78

Revision 78, 1.6 KB checked in by faltet, 4 years ago (diff)

Updated docs after the merge of the threaded code.

Line 
1Blosc: A blocking, shuffling and lossless compression library
2=============================================================
3
4.. #########################################################
5.. ################### W A R N I N G ! #####################
6.. #########################################################
7.. ### This is BETA software.  Use it at your own risk! ###
8.. #########################################################
9
10Author: Francesc Alted
11Official website: http://blosc.pytables.org
12
13Blosc is distributed using the MIT license, see file LICENSES
14directory for details.
15
16Blosc consists of the next files (in src/ directory):
17blosc.h and blosc.c      -- the main routines
18blosclz.h and blosclz.c  -- the actual compressor
19shuffle.h and shuffle.c  -- the shuffle code
20
21Just add these files to your project in order to use Blosc. For
22information on compression and decompression routines, see blosc.h.
23
24Blosc is a compressor for binary data, that can use threads and SSE2
25and that gets best results if you can provide the size of the data
26type that originated the data file.
27
28To compile using GCC:
29
30  gcc -O3 -msse2 -o your_program your_program.c \
31                    blosc.c blosclz.c shuffle.c -lpthread
32
33Using Windows and MSVC (remember to set the LIB and INCLUDE environment
34variables to pthread-win32 directories first):
35
36  cl /Ox /Feyour_program.exe your_program.c \
37          blosc.c blosclz.c shuffle.c  /link pthreadvc2.lib
38
39
40A simple usage example is the benchmark in the src/bench.c file.
41
42I have not tried to compile this with other compilers than GCC and
43MSVC yet.  Please report your experiences with your own platforms.
44
45Thank you!
Note: See TracBrowser for help on using the repository browser.