File
compat/zlib/contrib/dotzlib/readme.txt
— part of check-in
[d17f4473]
at
2012-11-27 06:31:19
on branch zlib
— Support building with zlib in the compat directory, phase 1.
(user:
mistachkin
size: 2358)
[more...]
0000: 54 68 69 73 20 64 69 72 65 63 74 6f 72 79 20 63 This directory c
0010: 6f 6e 74 61 69 6e 73 20 61 20 2e 4e 65 74 20 77 ontains a .Net w
0020: 72 61 70 70 65 72 20 63 6c 61 73 73 20 6c 69 62 rapper class lib
0030: 72 61 72 79 20 66 6f 72 20 74 68 65 20 5a 4c 69 rary for the ZLi
0040: 62 31 2e 64 6c 6c 0d 0a 0d 0a 54 68 65 20 77 72 b1.dll....The wr
0050: 61 70 70 65 72 20 69 6e 63 6c 75 64 65 73 20 73 apper includes s
0060: 75 70 70 6f 72 74 20 66 6f 72 20 69 6e 66 6c 61 upport for infla
0070: 74 69 6e 67 2f 64 65 66 6c 61 74 69 6e 67 20 6d ting/deflating m
0080: 65 6d 6f 72 79 20 62 75 66 66 65 72 73 2c 0d 0a emory buffers,..
0090: 2e 4e 65 74 20 73 74 72 65 61 6d 69 6e 67 20 77 .Net streaming w
00a0: 72 61 70 70 65 72 73 20 66 6f 72 20 74 68 65 20 rappers for the
00b0: 67 7a 20 73 74 72 65 61 6d 73 20 70 61 72 74 20 gz streams part
00c0: 6f 66 20 7a 6c 69 62 2c 20 61 6e 64 20 77 72 61 of zlib, and wra
00d0: 70 70 65 72 73 0d 0a 66 6f 72 20 74 68 65 20 63 ppers..for the c
00e0: 68 65 63 6b 73 75 6d 20 70 61 72 74 73 20 6f 66 hecksum parts of
00f0: 20 7a 6c 69 62 2e 20 53 65 65 20 44 6f 74 5a 4c zlib. See DotZL
0100: 69 62 2f 55 6e 69 74 54 65 73 74 73 2e 63 73 20 ib/UnitTests.cs
0110: 66 6f 72 20 65 78 61 6d 70 6c 65 73 2e 0d 0a 0d for examples....
0120: 0a 44 69 72 65 63 74 6f 72 79 20 73 74 72 75 63 .Directory struc
0130: 74 75 72 65 3a 0d 0a 2d 2d 2d 2d 2d 2d 2d 2d 2d ture:..---------
0140: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 0d 0a 0d 0a 4c -----------....L
0150: 49 43 45 4e 53 45 5f 31 5f 30 2e 74 78 74 20 20 ICENSE_1_0.txt
0160: 20 20 20 20 20 2d 20 4c 69 63 65 6e 73 65 20 66 - License f
0170: 69 6c 65 2e 0d 0a 72 65 61 64 6d 65 2e 74 78 74 ile...readme.txt
0180: 20 20 20 20 20 20 20 20 20 20 20 20 2d 20 54 68 - Th
0190: 69 73 20 66 69 6c 65 2e 0d 0a 44 6f 74 5a 4c 69 is file...DotZLi
01a0: 62 2e 63 68 6d 20 20 20 20 20 20 20 20 20 20 20 b.chm
01b0: 2d 20 43 6c 61 73 73 20 6c 69 62 72 61 72 79 20 - Class library
01c0: 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 0d 0a 44 documentation..D
01d0: 6f 74 5a 4c 69 62 2e 62 75 69 6c 64 20 20 20 20 otZLib.build
01e0: 20 20 20 20 20 2d 20 4e 41 6e 74 20 62 75 69 6c - NAnt buil
01f0: 64 20 66 69 6c 65 0d 0a 44 6f 74 5a 4c 69 62 2e d file..DotZLib.
0200: 73 6c 6e 20 20 20 20 20 20 20 20 20 20 20 2d 20 sln -
0210: 4d 69 63 72 6f 73 6f 66 74 20 56 69 73 75 61 6c Microsoft Visual
0220: 20 53 74 75 64 69 6f 20 32 30 30 33 20 73 6f 6c Studio 2003 sol
0230: 75 74 69 6f 6e 20 66 69 6c 65 0d 0a 0d 0a 44 6f ution file....Do
0240: 74 5a 4c 69 62 5c 2a 2e 63 73 20 20 20 20 20 20 tZLib\*.cs
0250: 20 20 20 20 2d 20 53 6f 75 72 63 65 20 66 69 6c - Source fil
0260: 65 73 20 66 6f 72 20 74 68 65 20 63 6c 61 73 73 es for the class
0270: 20 6c 69 62 72 61 72 79 0d 0a 0d 0a 55 6e 69 74 library....Unit
0280: 20 74 65 73 74 73 3a 0d 0a 2d 2d 2d 2d 2d 2d 2d tests:..-------
0290: 2d 2d 2d 2d 0d 0a 54 68 65 20 66 69 6c 65 20 44 ----..The file D
02a0: 6f 74 5a 4c 69 62 2f 55 6e 69 74 54 65 73 74 73 otZLib/UnitTests
02b0: 2e 63 73 20 63 6f 6e 74 61 69 6e 73 20 75 6e 69 .cs contains uni
02c0: 74 20 74 65 73 74 73 20 66 6f 72 20 75 73 65 20 t tests for use
02d0: 77 69 74 68 20 4e 55 6e 69 74 20 32 2e 31 20 6f with NUnit 2.1 o
02e0: 72 20 68 69 67 68 65 72 2e 0d 0a 54 6f 20 69 6e r higher...To in
02f0: 63 6c 75 64 65 20 75 6e 69 74 20 74 65 73 74 73 clude unit tests
0300: 20 69 6e 20 74 68 65 20 62 75 69 6c 64 2c 20 64 in the build, d
0310: 65 66 69 6e 65 20 6e 75 6e 69 74 20 62 65 66 6f efine nunit befo
0320: 72 65 20 62 75 69 6c 64 69 6e 67 2e 0d 0a 0d 0a re building.....
0330: 0d 0a 42 75 69 6c 64 20 69 6e 73 74 72 75 63 74 ..Build instruct
0340: 69 6f 6e 73 3a 0d 0a 2d 2d 2d 2d 2d 2d 2d 2d 2d ions:..---------
0350: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 0d 0a 0d 0a 31 2e ----------....1.
0360: 20 55 73 69 6e 67 20 56 69 73 75 61 6c 20 53 74 Using Visual St
0370: 75 64 69 6f 2e 4e 65 74 20 32 30 30 33 3a 0d 0a udio.Net 2003:..
0380: 20 20 20 4f 70 65 6e 20 44 6f 74 5a 4c 69 62 2e Open DotZLib.
0390: 73 6c 6e 20 69 6e 20 56 53 2e 4e 65 74 20 61 6e sln in VS.Net an
03a0: 64 20 62 75 69 6c 64 20 66 72 6f 6d 20 74 68 65 d build from the
03b0: 72 65 2e 20 4f 75 74 70 75 74 20 66 69 6c 65 20 re. Output file
03c0: 28 44 6f 74 5a 4c 69 62 2e 64 6c 6c 29 0d 0a 20 (DotZLib.dll)..
03d0: 20 20 77 69 6c 6c 20 62 65 20 66 6f 75 6e 64 20 will be found
03e0: 2e 2f 44 6f 74 5a 4c 69 62 2f 62 69 6e 2f 72 65 ./DotZLib/bin/re
03f0: 6c 65 61 73 65 20 6f 72 20 2e 2f 44 6f 74 5a 4c lease or ./DotZL
0400: 69 62 2f 62 69 6e 2f 64 65 62 75 67 2c 20 64 65 ib/bin/debug, de
0410: 70 65 6e 64 69 6e 67 20 6f 6e 0d 0a 20 20 20 79 pending on.. y
0420: 6f 75 20 61 72 65 20 62 75 69 6c 64 69 6e 67 20 ou are building
0430: 74 68 65 20 72 65 6c 65 61 73 65 20 6f 72 20 64 the release or d
0440: 65 62 75 67 20 76 65 72 73 69 6f 6e 20 6f 66 20 ebug version of
0450: 74 68 65 20 6c 69 62 72 61 72 79 2e 20 43 68 65 the library. Che
0460: 63 6b 0d 0a 20 20 20 44 6f 74 5a 4c 69 62 2f 55 ck.. DotZLib/U
0470: 6e 69 74 54 65 73 74 73 2e 63 73 20 66 6f 72 20 nitTests.cs for
0480: 69 6e 73 74 72 75 63 74 69 6f 6e 73 20 6f 6e 20 instructions on
0490: 68 6f 77 20 74 6f 20 69 6e 63 6c 75 64 65 20 75 how to include u
04a0: 6e 69 74 20 74 65 73 74 73 20 69 6e 20 74 68 65 nit tests in the
04b0: 0d 0a 20 20 20 62 75 69 6c 64 2e 0d 0a 0d 0a 32 .. build.....2
04c0: 2e 20 55 73 69 6e 67 20 4e 41 6e 74 3a 0d 0a 20 . Using NAnt:..
04d0: 20 20 4f 70 65 6e 20 61 20 63 6f 6d 6d 61 6e 64 Open a command
04e0: 20 70 72 6f 6d 70 74 20 77 69 74 68 20 61 63 63 prompt with acc
04f0: 65 73 73 20 74 6f 20 74 68 65 20 62 75 69 6c 64 ess to the build
0500: 20 65 6e 76 69 72 6f 6e 6d 65 6e 74 20 61 6e 64 environment and
0510: 20 72 75 6e 20 6e 61 6e 74 0d 0a 20 20 20 69 6e run nant.. in
0520: 20 74 68 65 20 73 61 6d 65 20 64 69 72 65 63 74 the same direct
0530: 6f 72 79 20 61 73 20 74 68 65 20 44 6f 74 5a 4c ory as the DotZL
0540: 69 62 2e 62 75 69 6c 64 20 66 69 6c 65 2e 0d 0a ib.build file...
0550: 20 20 20 59 6f 75 20 63 61 6e 20 64 65 66 69 6e You can defin
0560: 65 20 32 20 70 72 6f 70 65 72 74 69 65 73 20 6f e 2 properties o
0570: 6e 20 74 68 65 20 6e 61 6e 74 20 63 6f 6d 6d 61 n the nant comma
0580: 6e 64 2d 6c 69 6e 65 20 74 6f 20 63 6f 6e 74 72 nd-line to contr
0590: 6f 6c 20 74 68 65 20 62 75 69 6c 64 3a 0d 0a 20 ol the build:..
05a0: 20 20 64 65 62 75 67 3d 7b 74 72 75 65 7c 66 61 debug={true|fa
05b0: 6c 73 65 7d 20 74 6f 20 74 6f 67 67 6c 65 20 62 lse} to toggle b
05c0: 65 74 77 65 65 6e 20 72 65 6c 65 61 73 65 2f 64 etween release/d
05d0: 65 62 75 67 20 62 75 69 6c 64 73 20 28 64 65 66 ebug builds (def
05e0: 61 75 6c 74 3d 74 72 75 65 29 2e 0d 0a 20 20 20 ault=true)...
05f0: 6e 75 6e 69 74 3d 7b 74 72 75 65 7c 66 61 6c 73 nunit={true|fals
0600: 65 7d 20 74 6f 20 69 6e 63 6c 75 64 65 20 6f 72 e} to include or
0610: 20 65 73 63 6c 75 64 65 20 75 6e 69 74 20 74 65 esclude unit te
0620: 73 74 73 20 28 64 65 66 61 75 6c 74 3d 74 72 75 sts (default=tru
0630: 65 29 2e 0d 0a 20 20 20 41 6c 73 6f 20 74 68 65 e)... Also the
0640: 20 74 61 72 67 65 74 20 63 6c 65 61 6e 20 77 69 target clean wi
0650: 6c 6c 20 72 65 6d 6f 76 65 20 62 69 6e 61 72 69 ll remove binari
0660: 65 73 2e 0d 0a 20 20 20 4f 75 74 70 75 74 20 66 es... Output f
0670: 69 6c 65 20 28 44 6f 74 5a 4c 69 62 2e 64 6c 6c ile (DotZLib.dll
0680: 29 20 77 69 6c 6c 20 62 65 20 66 6f 75 6e 64 20 ) will be found
0690: 69 6e 20 65 69 74 68 65 72 20 2e 2f 44 6f 74 5a in either ./DotZ
06a0: 4c 69 62 2f 62 69 6e 2f 72 65 6c 65 61 73 65 0d Lib/bin/release.
06b0: 0a 20 20 20 6f 72 20 2e 2f 44 6f 74 5a 4c 69 62 . or ./DotZLib
06c0: 2f 62 69 6e 2f 64 65 62 75 67 2c 20 64 65 70 65 /bin/debug, depe
06d0: 6e 64 69 6e 67 20 6f 6e 20 77 68 65 74 68 65 72 nding on whether
06e0: 20 79 6f 75 20 61 72 65 20 62 75 69 6c 64 69 6e you are buildin
06f0: 67 20 74 68 65 20 72 65 6c 65 61 73 65 0d 0a 20 g the release..
0700: 20 20 6f 72 20 64 65 62 75 67 20 76 65 72 73 69 or debug versi
0710: 6f 6e 20 6f 66 20 74 68 65 20 6c 69 62 72 61 72 on of the librar
0720: 79 2e 0d 0a 0d 0a 20 20 20 45 78 61 6d 70 6c 65 y..... Example
0730: 73 3a 0d 0a 20 20 20 20 20 6e 61 6e 74 20 2d 44 s:.. nant -D
0740: 3a 64 65 62 75 67 3d 66 61 6c 73 65 20 2d 44 3a :debug=false -D:
0750: 6e 75 6e 69 74 3d 66 61 6c 73 65 0d 0a 20 20 20 nunit=false..
0760: 20 20 20 20 77 69 6c 6c 20 62 75 69 6c 64 20 61 will build a
0770: 20 72 65 6c 65 61 73 65 20 6d 6f 64 65 20 76 65 release mode ve
0780: 72 73 69 6f 6e 20 6f 66 20 74 68 65 20 6c 69 62 rsion of the lib
0790: 72 61 72 79 20 77 69 74 68 6f 75 74 20 75 6e 69 rary without uni
07a0: 74 20 74 65 73 74 73 2e 0d 0a 20 20 20 20 20 6e t tests... n
07b0: 61 6e 74 0d 0a 20 20 20 20 20 20 20 77 69 6c 6c ant.. will
07c0: 20 62 75 69 6c 64 20 61 20 64 65 62 75 67 20 76 build a debug v
07d0: 65 72 73 69 6f 6e 20 6f 66 20 74 68 65 20 6c 69 ersion of the li
07e0: 62 72 61 72 79 20 77 69 74 68 20 75 6e 69 74 20 brary with unit
07f0: 74 65 73 74 73 0d 0a 20 20 20 20 20 6e 61 6e 74 tests.. nant
0800: 20 63 6c 65 61 6e 0d 0a 20 20 20 20 20 20 20 77 clean.. w
0810: 69 6c 6c 20 72 65 6d 6f 76 65 20 61 6c 6c 20 70 ill remove all p
0820: 72 65 76 69 6f 75 73 6c 79 20 62 75 69 6c 74 20 reviously built
0830: 66 69 6c 65 73 2e 0d 0a 0d 0a 0d 0a 2d 2d 2d 2d files.......----
0840: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d ----------------
0850: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 0d 0a 43 -------------..C
0860: 6f 70 79 72 69 67 68 74 20 28 63 29 20 48 65 6e opyright (c) Hen
0870: 72 69 6b 20 52 61 76 6e 20 32 30 30 34 0d 0a 0d rik Ravn 2004...
0880: 0a 55 73 65 2c 20 6d 6f 64 69 66 69 63 61 74 69 .Use, modificati
0890: 6f 6e 20 61 6e 64 20 64 69 73 74 72 69 62 75 74 on and distribut
08a0: 69 6f 6e 20 61 72 65 20 73 75 62 6a 65 63 74 20 ion are subject
08b0: 74 6f 20 74 68 65 20 42 6f 6f 73 74 20 53 6f 66 to the Boost Sof
08c0: 74 77 61 72 65 20 4c 69 63 65 6e 73 65 2c 20 56 tware License, V
08d0: 65 72 73 69 6f 6e 20 31 2e 30 2e 0d 0a 28 53 65 ersion 1.0...(Se
08e0: 65 20 61 63 63 6f 6d 70 61 6e 79 69 6e 67 20 66 e accompanying f
08f0: 69 6c 65 20 4c 49 43 45 4e 53 45 5f 31 5f 30 2e ile LICENSE_1_0.
0900: 74 78 74 20 6f 72 20 63 6f 70 79 20 61 74 20 68 txt or copy at h
0910: 74 74 70 3a 2f 2f 77 77 77 2e 62 6f 6f 73 74 2e ttp://www.boost.
0920: 6f 72 67 2f 4c 49 43 45 4e 53 45 5f 31 5f 30 2e org/LICENSE_1_0.
0930: 74 78 74 29 0d 0a txt)..