Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.04 KB

UserGuide.adoc

File metadata and controls

75 lines (50 loc) · 2.04 KB
Raw

JavaCake - User Guide

1. Introduction

JavaCake is for those who prefer to use a desktop app for managing events preceding a wedding. More importantly, JavaCake is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, JavaCake can get your wedding planning tasks done faster than traditional GUI apps.

2. Getting Started

  1. Install JDK 11

  2. Download the latest jar and put it in a directory of your choice

  3. Double click the jar file to run

  4. Type help and click ‘Enter’ to get the list of available commands

  5. Common commands:

    • list: List all the tasks that are available

    • todo <TASK_NAME/>: Adds a general task to the list (No duration/time listed)

    • delete <TASK_NUM/>: Deletes the task at corresponding index from the list

    • bye: Exits the app

  6. Refer to Section 3, “Features” for more in-depth details for each command

3. Features

Command Format

3.1. Getting the available commands : help

3.2. Getting the available tasks: list

3.3. Adding a generic task to the list: todo <TASK_NAME/>

3.4. Adding a task with a period to do by: deadline

Format: deadline <TASK_NAME/> /by <TASK_PERIOD/>

3.5. Adding a task that has an event to attend to: event

Format: event <TASK_NAME/> /at <TASK_PERIOD/>

3.6. Postponing a deadline or event: snooze

Format: snooze <TASK_NUM/> /to <NEW_TASK_PERIOD/>

3.7. Changing the task from a list: edit

Format: edit <TASK_NUM/> /to <NEW_TASK_NAME/>

3.8. Deleting a task from a list: delete

Format: delete <TASK_NUM/>

3.9. Exiting the program: exit

3.10. Saving the data: Automatically saved after each command

4. FAQ

5. Common Command Examples