Sha256: 31cb4853f20464c500463443036ccb4fd717903554eb937d79344c0c7705911d

Contents?: true

Size: 602 Bytes

Versions: 13

Compression:

Stored size: 602 Bytes

Contents

# helpers for parsing the top-level README file (no suffix support :P)
module Wrongdoc::Readme

  # returns a one-paragraph summary from the README
  def readme_description
    File.read("README").split(/\n\n/)[1]
  end

  # parses the README file in the top-level directory for project metadata
  def readme_metadata
    l = File.readlines("README")[0].strip!
    l.gsub!(/^=\s+/, '') or abort "#{l.inspect} doesn't start with '='"
    title = l.dup
    if l.gsub!(/^(\w+\!)\s+/, '') # Rainbows!
      return $1, l, title
    else
      return (l.split(/\s*[:-]\s*/, 2)).push(title)
    end
  end
end

Version data entries

13 entries across 13 versions & 1 rubygems

Version Path
wrongdoc-1.8.1 lib/wrongdoc/readme.rb
wrongdoc-1.8.0 lib/wrongdoc/readme.rb
wrongdoc-1.7.0 lib/wrongdoc/readme.rb
wrongdoc-1.6.2 lib/wrongdoc/readme.rb
wrongdoc-1.6.1 lib/wrongdoc/readme.rb
wrongdoc-1.6.0 lib/wrongdoc/readme.rb
wrongdoc-1.5.0 lib/wrongdoc/readme.rb
wrongdoc-1.4.0 lib/wrongdoc/readme.rb
wrongdoc-1.3.0 lib/wrongdoc/readme.rb
wrongdoc-1.1.1 lib/wrongdoc/readme.rb
wrongdoc-1.1.0 lib/wrongdoc/readme.rb
wrongdoc-1.0.1 lib/wrongdoc/readme.rb
wrongdoc-1.0.0 lib/wrongdoc/readme.rb