README in rio-0.3.8 vs README in rio-0.3.9
- old
+ new
@@ -1,6 +1,6 @@
-Copyright (c) 2005, 2006 Christopher Kleckner
+Copyright (c) 2005,2006,2007 Christopher Kleckner
All rights reserved
This file is part of the Rio library for ruby.
Rio is free software; you can redistribute it and/or modify
@@ -16,35 +16,40 @@
You should have received a copy of the GNU General Public License
along with Rio; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-<b>Rio is pre-alpha software.
-The documented interface and behavior is subject to change without notice.</b>
-
=== Rio - Ruby I/O Comfort Class
-Rio is a convenience class wrapping much of the functionality of
-IO, File, Dir, Pathname, FileUtils, Tempfile, StringIO, OpenURI, Zlib, and CSV.
+Rio wraps much of the functionality of IO, File, Dir, Pathname, FileUtils,
+Tempfile, StringIO, OpenURI, Zlib, and CSV.
+==== Building the documentation
+
To create the documentation for Rio run the command
ruby build_doc.rb
-from the distribution directory.
+from the distribution directory.
Then point your browser at the 'doc/rdoc' directory.
-Suggested Reading
+The RDoc template file included with the distribution contains some RDoc hacks
+that overcomes some of RDoc's weaknesses and makes the documentation *much* more
+usable. It is unadvisable to build the RDoc documentation without these.
+
+
+===== Suggested Reading
* RIO::Doc::SYNOPSIS
* RIO::Doc::INTRO
* RIO::Doc::HOWTO
+* RIO::Doc::EXAMPLES
* RIO::Rio
-To install Rio untar the distribution and type
- ruby setup.rb config
- ruby setup.rb setup
- ruby setup.rb install
+==== Installation
+To install Rio from the distribution directory type
+ ruby setup.rb
+
Rio is also available as a gem. If you have rubygems installed use:
gem install rio
To use Rio as a rubygem:
require 'rubygems'
@@ -53,9 +58,10 @@
To read the documentation without running rdoc, read the files:
* lib/rio/doc/SYNOPSIS.rb
* lib/rio/doc/INTRO.rb
* lib/rio/doc/HOWTO.rb
* lib/rio/if/*.rb
+
Project:: http://rubyforge.org/projects/rio/
Documentation:: http://rio.rubyforge.org/
Bugs:: http://rubyforge.org/tracker/?group_id=821
Email:: rio4ruby@rubyforge.org