README in rio-0.4.2 vs README in rio-0.5.1
- old
+ new
@@ -1,6 +1,6 @@
-Copyright (c) 2005,2006,2007,2008 Christopher Kleckner
+Copyright (c) 2005-2012 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
@@ -27,52 +27,45 @@
functionality provided by IO, File, Dir, Pathname, FileUtils,
Tempfile, StringIO, OpenURI and others. Rio also provides an
application level interface which allows many common I/O idioms to be
expressed succinctly.
-==== Building the documentation
+==== Installation
-To create the documentation for Rio run the command
- ruby build_doc.rb
-from the distribution directory.
-Then point your browser at the 'doc/rdoc' directory.
+Add this line to your application's Gemfile:
-The RDoc template file included with this distribution contains some
-RDoc hacks that overcomes some of RDoc's weaknesses and makes the
-documentation *much* more usable. It is inadvisable to build the RDoc
-documentation without these.
+ gem 'rio'
+And then execute:
-===== Suggested Reading
+ $ bundle
+Or install it yourself as:
+
+ $ gem install rio
+
+==== Usage
+
* RIO::Doc::SYNOPSIS
* RIO::Doc::INTRO
* RIO::Doc::HOWTO
* RIO::Doc::EXAMPLES
* RIO::Rio
-==== Installation
-To install Rio from the distribution directory type
- ruby setup.rb
+==== Contributing
-Rio is also available as a gem. If you have rubygems installed use:
- gem install rio
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
-To use Rio as a rubygem:
- require 'rubygems'
- require 'rio'
-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/
+Documentation:: http://rio4ruby.com/
Bugs:: http://rubyforge.org/tracker/?group_id=821
Blog:: http://rio4ruby.blogspot.com/
Email:: rio4ruby@rubyforge.org
+