FLACKPAD README

I. Student Information

Student 1

Name:         Fletcher van Ameringen;
Student ID:   19023939

Student 2

Name:         Jack Sandford;
Student ID:   19025303

II. FlackPad Application

1. How to run our program

• Java version 1.8 or greater is required to run this application
• Simply launch the FlackPad application (JAR)
• A configuration file will be automatically generated if one is not in the working directory

2. Core features

This application has the following core features, as per the assignment brief:

• New, Open, Exit, Time & Date, About
• Select, Copy, Paste & Cut, Delete
• Save, Save As, Search
• Print
• Ability to open ODT and RTF files (Saving does not overwrite the original files)
• Exporting to PDF (PDF Conversion Function)
  , ODT and RTF
• Source Code Syntax Highlighting (Theme-Based)
• Configuration File to Save Font & Theme Options (YAML)

3. Additional features worth mentioning

• New Window (‘New Window’ will open a new text-editing instance in an additional application window, whilst ‘New’ will open a new text-editing instance in the current application window)
• Select All (Select all current text)
• Replace Text (In conjunction with ‘Search’ feature)
• Keyboard Shorcuts (Mnemonics, including additional keyboard combinations, for all listed operations)
• Line Numbers
• Brace Folding (Syntactical)
• Dark & Light Themes
• Editor Configuration Dialog (Fonts, Sizing, & Theme Selection)
• Character Count
• File Type Detection (Shown adjacent to Character Count)
• Undo / Redo
• Zoom In / Zoom Out / Reset Zoom
• Basic Autocompletion (ctrl + spacebar shortcut)
• Custom scrollbar
• Testing & Continuous Integration (Travis)
• Status bar

III. Significant Commit ID’s

Fletcher:

commit-1

commit-2

commit-3

commit-4

commit-5

Jack:

commit-1

commit-2

commit-3

commit-4

commit-5