Added ARC support through Nick Lockwood's ARC Helper; README updated; bumped version to 0.8.1

This commit is contained in:
Gianluca Bertani
2013-03-04 23:24:24 +01:00
parent df4a2ebd00
commit 667b62fcc1
14 changed files with 130 additions and 22 deletions
+19 -5
View File
@@ -1,4 +1,5 @@
Getting started with Objective-Zip
==================================
@@ -6,19 +7,23 @@ Objective-Zip exposes basic functionalities to read and write zip files,
encapsulating both ZLib for the compression mechanism and MiniZip for
the zip wrapping.
Adding Objective-Zip to your project
------------------------------------
The library is distributed as source only, so simply download the unit
test application and copy-paste these directories in your own project:
- ZLib,
- MiniZip,
- Objective-Zip.
- ARCHelper
- ZLib
- MiniZip
- Objective-Zip
The first two are simply copies of the distribution of version 1.2.7 of
ZLib and of version 1.1 of MiniZip (which is itself part of ZLib
contributions), while the third is their Objective-C wrapper.
Main concepts
-------------
@@ -35,6 +40,7 @@ is a read-only modality. You can not request reading operations on a
write-mode zip file, nor request writing operations on a read-mode zip
file.
Adding a file to a zip file
---------------------------
@@ -50,6 +56,7 @@ the file, and then must be closed:
[stream writeData:abcData];
[stream finishedWriting];
Reading a file from a zip file
------------------------------
@@ -75,6 +82,7 @@ have been set with a length greater than 0: the readDataWithBuffer API
will use that length to know how many bytes it can fetch from the zip
file.
Listing files in a zip file
---------------------------
@@ -102,8 +110,10 @@ zip and expand it:
}
Note that the FileInZipInfo class provide two sizes:
- length is the original (uncompressed) file size, while
- size is the compressed file size.
- **length** is the original (uncompressed) file size, while
- **size** is the compressed file size.
Closing the zip file
--------------------
@@ -113,9 +123,11 @@ file corruption problems:
[zipFile close];
Notes
=====
File/folder hierarchy inide the zip
-----------------------------------
@@ -126,6 +138,7 @@ extracts the files to consider these file names as expressing a
structure and rebuild it on the file system (and viceversa during
creation). Common zippers/unzippers simply follow this rule.
Memory management
-----------------
@@ -162,6 +175,7 @@ you can do so using a read-then-write buffered loop like this:
[read finishedReading];
[buffer release];
Exception handling
------------------