RDoc::Readme - Extract high-level RDOC for use in a README file

Usage

require 'rdoc-readme'

RDoc::Readme.new do |rdoc|
  # Read from file
  rdoc.from_file(file_name).each { |line| puts line }

  # Read from file handle
  rdoc.from_file_handle($stdin).each { |line| puts line }
end

Rake Task

require 'rdoc-readme/rake_task'

# Pull in RDoc from source file and print to destination file.
RDoc::Readme::RakeTask.new 'lib/rdoc-readme.rb', 'README.rdoc'

# Pull in RDoc from source file and print to $stdout.
RDoc::Readme::RakeTask.new 'lib/rdoc-readme.rb'

# Pull in RDoc from $stdin and print to $stdout.
RDoc::Readme::RakeTask.new

Author

blair christensen. <blair.christensen@gmail.com>

Homepage

github.com/blairc/rdoc-readme/

To Do

• Use RDoc and/or YARD to handle the parsing.