readme.txt 2.3 KB

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