rubyzip

Go to file

thomas adaaf8337c Added more rdoc and changed the remaining tests to Test::Unit		2005-02-19 20:30:33 +00:00
lib/zip	Added more rdoc and changed the remaining tests to Test::Unit	2005-02-19 20:30:33 +00:00
samples	Improvements to Rakefile	2005-02-16 17:47:44 +00:00
test	Added more rdoc and changed the remaining tests to Test::Unit	2005-02-19 20:30:33 +00:00
.cvsignore	* empty log message *	2002-09-09 21:48:08 +00:00
NEWS	Improved documentation and added rdoc task to Rakefile	2005-02-16 19:04:32 +00:00
README	* empty log message *	2005-02-18 09:27:37 +00:00
Rakefile	Added ppackage (publish package) task to Rakefile	2005-02-17 22:21:59 +00:00
TODO	Added pdoc (publish doc) task to Rakefile	2005-02-17 21:49:16 +00:00
install.rb	Made install.rb independent of the current path (fixes bug reported by Drew Robinson)	2005-02-13 20:53:12 +00:00

README

= rubyzip

rubyzip is a ruby library for reading and writing zip files.

= Install

To install from source run 

  ruby install.rb

If you have Rake installed you can build a rubyzip gem with 

  rake package

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

  rake test


= Documentation

There is more than one way to access or create a zip archive with
rubyzip. The basic API is modeled after the classes in
java.util.zip from the Java SDK. This means there are classes such
as Zip::ZipInputStream, Zip::ZipOutputStream and
Zip::ZipFile. Zip::ZipInputStream provides a basic interface for
iterating through the entries in a zip archive and reading from the
entries in the same way as from a regular File or IO
object. ZipOutputStream is the corresponding basic output
facility. Zip::ZipFile provides a mean for accessing the archives
central directory and provides means for accessing any entry without
having to iterate through the archive. Unlike Java's
java.util.zip.ZipFile rubyzip's Zip::ZipFile is mutable, which means
it can be used to change zip files as well.

Another way to access a zip archive with rubyzip is to use rubyzip's
Zip::ZipFileSystem API. Using this API files can be read from and
written to the archive in much the same manner as ruby's builtin
classes allows files to be read from and written to the file system.

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.

= License

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


= Website and Project Home

http://rubyzip.sourceforge.net

http://sourceforge.net/projects/rubyzip

== Download (tarballs and gems)

http://sourceforge.net/project/showfiles.php?group_id=43107&package_id=35377

= Authors

Thomas Sondergaard (thomas at sondergaard.cc)

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