Class: Rubysmith::Builders::Documentation::Readme

Inherits:
Abstract
  • Object
show all
Defined in:
lib/rubysmith/builders/documentation/readme.rb

Overview

Builds project skeleton README documentation.

Instance Method Summary collapse

Methods inherited from Abstract

#initialize

Constructor Details

This class inherits a constructor from Rubysmith::Builders::Abstract

Instance Method Details

#call ⇒ Object 



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

def call
  return false unless settings.build_readme

  builder.call(settings.merge(template_path: "%project_name%/README.#{kind}.erb"))
         .render
         .replace(/\n{2,}/, "\n\n")
         .replace("\n    \n", "\n")

  true
end