annotate src/zlib-1.2.8/contrib/dotzlib/readme.txt @ 83:ae30d91d2ffe

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