Go to file
thomas c3949e3e73 Applied extra-field patch 2004-01-30 15:07:56 +00:00
samples Moved all production source files to zip/ so they are in the same dir as when they are installed 2003-08-21 13:54:32 +00:00
test Applied extra-field patch 2004-01-30 15:07:56 +00:00
zip Applied extra-field patch 2004-01-30 15:07:56 +00:00
.cvsignore *** empty log message *** 2002-09-09 21:48:08 +00:00
NEWS Fixed ZipFile.get_ouput_stream bug - data was never written to zip 2003-08-23 07:42:55 +00:00
README Applied extra-field patch 2004-01-30 15:07:56 +00:00
TODO *** empty log message *** 2003-12-13 15:53:53 +00:00
install.rb *** empty log message *** 2003-08-21 14:05:57 +00:00

README

= rubyzip

rubyzip is a ruby library for reading and writing zip (pkzip format)
files, with the restriction that only uncompressed and deflated zip
entries are supported. All this library does is handling of the zip
file format. the actual compression/decompression is handled by
zlib. zlib is accessible from ruby thanks to ruby/zlib (see below)

To run the unit tests you need to have rubyunit or test::unit
installed.

= Install

ruby install.rb


= Prerequisites

This library requires ruby/zlib version 0.5.0 or newer. ruby/zlib is
included in most recent ruby distributions.

* zlib http://www.gzip.org/zlib/
* ruby-zlib: http://www.blue.sky.or.jp/atelier/ruby/


= Documentation

The samples/ directory is a good place to start to get a feel for
using the library. For details about the specific behaviour of classes
and methods refer to the test suite. Finally you can generate the rdoc
documentation or visit http://rubyzip.sourceforge.net/doc.


= License

rubyzip is distributed under the same license as ruby. See
http://www.ruby-lang.org/en/LICENSE.txt


= Project Home

http://rubyzip.sourceforge.net


= Author

Thomas Sondergaard (thomas at thomassondergaard.com)

extra-field support contributed by Tatsuki Sugiura (sugi at nemui.org)