Module: Description

Included in:

FileRenamer

Defined in:

lib/android_file_sorter/description.rb

Instance Method Summary

• #documentation ⇒ Object
• #options ⇒ Object

Instance Method Details

#documentation ⇒ Object

# File 'lib/android_file_sorter/description.rb', line 3

def documentation
  puts <<-DOC

How do your files get renamed?
------------------------------
You are naming filesets, not files. That means that if you have eleven files recorded on the
same day, after your provide your new name e.g. "My birthday", all files recorded on the same day
will be renamed to "My_birthday".
For convenience, AnroidFileSorter will give each file a number "My_birthday_1" and remove a time stamp.
This way, you will still know the order in which files were recorded (pictures or videos taken).
Final name will include a date stamp however, so our example files will be named
"My_birthday_2015-08-15_Tue_1".

  DOC
end

#options ⇒ Object

# File 'lib/android_file_sorter/description.rb', line 19

def options
  puts <<-OPTIONS
Proceed with renaming your files:
 - [ l ] leave a fileset as is
 - [ a ] let AFS name files for you
 - [ d ] show documentation
 - [ e ] exit program
 - [ r ] rename files yourself

  OPTIONS
end