Class: Quartet::Builders::Readme

Inherits:
Builder
  • Object
show all
Defined in:
lib/quartet/builders/readme.rb

Instance Method Summary collapse

Methods inherited from Builder

#filepath, #underscore

Constructor Details

#initialize ⇒ Readme

Returns a new instance of Readme.



5
6
7
8
9
 
# File 'lib/quartet/builders/readme.rb', line 5

def initialize
  @name_override = 'README'
  @directory = ''
  @file_type = '.md'
end

Instance Method Details

#build(app_name) ⇒ Object 



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

def build(app_name)
  %(# #{app_name}
Things to include here:
- A description of your app
- Instructions for installation/build
- Instructions for development/running tests etc
- Licence information
- ...
)
end