|
cannam@89
|
1 This directory contains a .Net wrapper class library for the ZLib1.dll
|
|
cannam@89
|
2
|
|
cannam@89
|
3 The wrapper includes support for inflating/deflating memory buffers,
|
|
cannam@89
|
4 .Net streaming wrappers for the gz streams part of zlib, and wrappers
|
|
cannam@89
|
5 for the checksum parts of zlib. See DotZLib/UnitTests.cs for examples.
|
|
cannam@89
|
6
|
|
cannam@89
|
7 Directory structure:
|
|
cannam@89
|
8 --------------------
|
|
cannam@89
|
9
|
|
cannam@89
|
10 LICENSE_1_0.txt - License file.
|
|
cannam@89
|
11 readme.txt - This file.
|
|
cannam@89
|
12 DotZLib.chm - Class library documentation
|
|
cannam@89
|
13 DotZLib.build - NAnt build file
|
|
cannam@89
|
14 DotZLib.sln - Microsoft Visual Studio 2003 solution file
|
|
cannam@89
|
15
|
|
cannam@89
|
16 DotZLib\*.cs - Source files for the class library
|
|
cannam@89
|
17
|
|
cannam@89
|
18 Unit tests:
|
|
cannam@89
|
19 -----------
|
|
cannam@89
|
20 The file DotZLib/UnitTests.cs contains unit tests for use with NUnit 2.1 or higher.
|
|
cannam@89
|
21 To include unit tests in the build, define nunit before building.
|
|
cannam@89
|
22
|
|
cannam@89
|
23
|
|
cannam@89
|
24 Build instructions:
|
|
cannam@89
|
25 -------------------
|
|
cannam@89
|
26
|
|
cannam@89
|
27 1. Using Visual Studio.Net 2003:
|
|
cannam@89
|
28 Open DotZLib.sln in VS.Net and build from there. Output file (DotZLib.dll)
|
|
cannam@89
|
29 will be found ./DotZLib/bin/release or ./DotZLib/bin/debug, depending on
|
|
cannam@89
|
30 you are building the release or debug version of the library. Check
|
|
cannam@89
|
31 DotZLib/UnitTests.cs for instructions on how to include unit tests in the
|
|
cannam@89
|
32 build.
|
|
cannam@89
|
33
|
|
cannam@89
|
34 2. Using NAnt:
|
|
cannam@89
|
35 Open a command prompt with access to the build environment and run nant
|
|
cannam@89
|
36 in the same directory as the DotZLib.build file.
|
|
cannam@89
|
37 You can define 2 properties on the nant command-line to control the build:
|
|
cannam@89
|
38 debug={true|false} to toggle between release/debug builds (default=true).
|
|
cannam@89
|
39 nunit={true|false} to include or esclude unit tests (default=true).
|
|
cannam@89
|
40 Also the target clean will remove binaries.
|
|
cannam@89
|
41 Output file (DotZLib.dll) will be found in either ./DotZLib/bin/release
|
|
cannam@89
|
42 or ./DotZLib/bin/debug, depending on whether you are building the release
|
|
cannam@89
|
43 or debug version of the library.
|
|
cannam@89
|
44
|
|
cannam@89
|
45 Examples:
|
|
cannam@89
|
46 nant -D:debug=false -D:nunit=false
|
|
cannam@89
|
47 will build a release mode version of the library without unit tests.
|
|
cannam@89
|
48 nant
|
|
cannam@89
|
49 will build a debug version of the library with unit tests
|
|
cannam@89
|
50 nant clean
|
|
cannam@89
|
51 will remove all previously built files.
|
|
cannam@89
|
52
|
|
cannam@89
|
53
|
|
cannam@89
|
54 ---------------------------------
|
|
cannam@89
|
55 Copyright (c) Henrik Ravn 2004
|
|
cannam@89
|
56
|
|
cannam@89
|
57 Use, modification and distribution are subject to the Boost Software License, Version 1.0.
|
|
cannam@89
|
58 (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
