Skip to content

Commit 06dc02e

Browse files
committedJun 28, 2008
Added RDoc README for GitHub
1 parent ddeb10b commit 06dc02e

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed
 

‎README.rdoc

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
= rubyzip
2+
3+
rubyzip is a ruby library for reading and writing zip files.
4+
5+
= Install
6+
7+
If you have rubygems you can install rubyzip directly from the gem
8+
repository
9+
10+
gem install rubyzip
11+
12+
Otherwise obtain the source (see below) and run
13+
14+
ruby install.rb
15+
16+
To run the unit tests you need to have test::unit installed
17+
18+
rake test
19+
20+
21+
= Documentation
22+
23+
There is more than one way to access or create a zip archive with
24+
rubyzip. The basic API is modeled after the classes in
25+
java.util.zip from the Java SDK. This means there are classes such
26+
as Zip::ZipInputStream, Zip::ZipOutputStream and
27+
Zip::ZipFile. Zip::ZipInputStream provides a basic interface for
28+
iterating through the entries in a zip archive and reading from the
29+
entries in the same way as from a regular File or IO
30+
object. ZipOutputStream is the corresponding basic output
31+
facility. Zip::ZipFile provides a mean for accessing the archives
32+
central directory and provides means for accessing any entry without
33+
having to iterate through the archive. Unlike Java's
34+
java.util.zip.ZipFile rubyzip's Zip::ZipFile is mutable, which means
35+
it can be used to change zip files as well.
36+
37+
Another way to access a zip archive with rubyzip is to use rubyzip's
38+
Zip::ZipFileSystem API. Using this API files can be read from and
39+
written to the archive in much the same manner as ruby's builtin
40+
classes allows files to be read from and written to the file system.
41+
42+
rubyzip also features the
43+
zip/ziprequire.rb[link:files/lib/zip/ziprequire_rb.html] module which
44+
allows ruby to load ruby modules from zip archives.
45+
46+
For details about the specific behaviour of classes and methods refer
47+
to the test suite. Finally you can generate the rdoc documentation or
48+
visit http://rubyzip.sourceforge.net.
49+
50+
= License
51+
52+
rubyzip is distributed under the same license as ruby. See
53+
http://www.ruby-lang.org/en/LICENSE.txt
54+
55+
56+
= Website and Project Home
57+
58+
http://rubyzip.sourceforge.net
59+
60+
http://sourceforge.net/projects/rubyzip
61+
62+
== Download (tarballs and gems)
63+
64+
http://sourceforge.net/project/showfiles.php?group_id=43107&package_id=35377
65+
66+
= Authors
67+
68+
Thomas Sondergaard (thomas at sondergaard.cc)
69+
70+
Technorama Ltd. (oss-ruby-zip at technorama.net)
71+
72+
extra-field support contributed by Tatsuki Sugiura (sugi at nemui.org)

0 commit comments

Comments
 (0)
Please sign in to comment.