Class: Gemsmith::Builders::Documentation::Readme

Inherits:
Rubysmith::Builders::Documentation::Readme
  • Object
show all
Defined in:
lib/gemsmith/builders/documentation/readme.rb

Overview

Builds project skeleton README documentation.

Instance Method Summary collapse

Instance Method Details

#call ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/gemsmith/builders/documentation/readme.rb', line 12

def call
  return false unless settings.build_readme

  super
  builder.call(settings.merge(template_path: "%project_name%/README.#{kind}.erb"))
         .replace(/Setup.+Usage/m, setup)
         .replace("Rubysmith", "Gemsmith")
         .replace("rubysmith", "gemsmith")

  true
end