Skip to content

Commit

Permalink
Add user guide and update UI image
Browse files Browse the repository at this point in the history
  • Loading branch information
dasha3412 committed Sep 18, 2024
1 parent ae63c09 commit e34bbd6
Show file tree
Hide file tree
Showing 4 changed files with 87 additions and 17 deletions.
100 changes: 85 additions & 15 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,100 @@
# Duke User Guide
# Victor TaskBot User Guide

// Update the title above to match the actual product name
![Product Screenshot](Ui.png)

// Product screenshot goes here
The Victor TaskBot is your best bet for keeping track of your To-Dos, Events, and Deadlines in a cute, stylish way!
Victor saves your tasks and loads them up for you each time you open the app, so you never have to worry about losing
track of any tasks!

// Product intro goes here

> Words in **ALL_CAPITALS** are parameters to be supplied by the user
## Adding to-dos

Add a to-do to your task list by typing in the command todo, followed by the name of your todo.

**Format:** todo TASK_DESCRIPTION

Examples:
* todo Finish CS Assignment
* todo Task with Very Long Description

## Adding deadlines

// Describe the action and its outcome.
Add a deadline by typing in the command deadline, followed by the name and the date of the deadline.

**Format:** deadline DEADLINE_DESCRIPTION /by DATE

> Dates for deadlines and events should be input either in YYYY-MM-DD or DD-MM-YYYY format.
Examples:

* deadline Submit Report /by 11-12-2024
* deadline Call Office of Admissions /by 2029-01-01


## Adding events

Add an event by typing in the command event, followed by the name, the start date, and the end date of the event.

**Format**: event EVENT_DESCRIPTION /from START_DATE /to END_DATE

Examples:

* event Attend Conference /from 06-06-2025 /to 09-09-2025
* event Quantitative Finance Take-Home Exam /from 2021-03-20 /to 2021-03-22

> * Make sure your end date is after your start date!
> * The start and end dates can be input in different formats.
You should see Victor's response keeping track of your deadline, similar to this:

## Marking tasks as complete or unfinished

Mark any task as finished or unfinished by typing in the command mark/unmark and the number of the task.

**Format:** (un)mark TASK_NUMBER

Examples:

* mark 2
* unmark 19

> Task numbering starts from 1 in the Victor TaskBot system.
## Listing tasks

To see all the tasks Victor is keeping track of, just type in list.

**Format:** list

## Deleting tasks

Delete tasks by typing in the delete command and the number of the task you want to delete.

**Format:** delete TASK_NUMBER

## Finding tasks by keyword

// Give examples of usage
Find a task based on a keyword or phrase by typing in find followed by the keyword or phrase you want to find.

Example: `keyword (optional arguments)`
**Format:** find KEYWORD

// A description of the expected outcome goes here
Examples:

```
expected output
```
* find call
* find Submit report

## Feature ABC
## Exiting the application

// Feature details
To exit the application, either close the window manually or type in exit or bye.

**Format:** bye/exit

## Feature XYZ
## Saving and Loading Data

// Feature details
The tasks input in one session are automatically saved to the hard disk
and loaded when another session of the application is started. If a line of the file is
in the wrong format, the application will overwrite that line and delete it from its records.
If no file is found, then the application will create a new file at /data/data.txt to store
the data.
Binary file modified docs/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/main/resources/view/DialogBox.fxml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<font>
<Font name="Georgia" size="13.0" />
</font></Label>
<ImageView fx:id="displayPicture" fitHeight="99.0" fitWidth="99.0" pickOnBounds="true" preserveRatio="true">
<ImageView fx:id="displayPicture" fitHeight="75.0" fitWidth="75.0" pickOnBounds="true" preserveRatio="true">
<HBox.margin>
<Insets left="10.0" right="10.0" />
</HBox.margin></ImageView>
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/view/VictorDialogBox.fxml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<font>
<Font name="Georgia" size="13.0" />
</font></Label>
<ImageView fx:id="displayPicture" fitHeight="99.0" fitWidth="99.0" pickOnBounds="true" preserveRatio="true">
<ImageView fx:id="displayPicture" fitHeight="75.0" fitWidth="75.0" pickOnBounds="true" preserveRatio="true">
<HBox.margin>
<Insets left="10.0" right="10.0" />
</HBox.margin></ImageView>
Expand Down

0 comments on commit e34bbd6

Please sign in to comment.