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