Sha256: a1463e490b81a84119747fae5180d0fbfc0b0d52ab94f4ce09deb7f288a8b9f3

Contents?: true

Size: 734 Bytes

Versions: 10

Compression:

Stored size: 734 Bytes

Contents

# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>

# helpers for parsing the top-level README file
module Olddoc::Readme # :nodoc:

  def readme_path
    'README'
  end

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

  # parses the README file in the top-level directory for project metadata
  def readme_metadata
    l = File.readlines(readme_path)[0].strip!
    l.gsub!(/^=\s+/, '')
    title = l.dup
    if l.gsub!(/^(\w+\!)\s+/, '') # special case for Rainbows!
      return $1, l, title
    else
      return (l.split(/\s*[:-]\s*/, 2)).push(title)
    end
  end
end

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
olddoc-1.9.0 lib/olddoc/readme.rb
olddoc-1.8.0 lib/olddoc/readme.rb
olddoc-1.7.1 lib/olddoc/readme.rb
olddoc-1.7.0 lib/olddoc/readme.rb
olddoc-1.6.0 lib/olddoc/readme.rb
olddoc-1.5.1 lib/olddoc/readme.rb
olddoc-1.5.0 lib/olddoc/readme.rb
olddoc-1.4.0 lib/olddoc/readme.rb
olddoc-1.3.0 lib/olddoc/readme.rb
olddoc-1.2.0 lib/olddoc/readme.rb