Skip to content

Commit

Permalink
Add Window Title, UI screenshot and User Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
gabztcr committed Sep 17, 2020
1 parent 466fcb0 commit 875cf16
Show file tree
Hide file tree
Showing 5 changed files with 108 additions and 12 deletions.
111 changes: 104 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,117 @@
# User Guide
# Lana del Taco User Guide

## Application UI

![Image of LanaDelTaco](https://github.com/gabztcr/ip/blob/master/docs/Ui.png)

## Features

### Feature 1
Description of feature.
### Add new task
Add new ToDo, Deadline or Event for Lana to track.

### View tasks
See all the tasks that are currently tracked by Lana.

### Edit the completion status of task(s)
Mark task(s) as done once you've completed them.

### Delete task(s)
Delete task(s) you no longer want to track.

### Find task(s)
Find all tracked task(s) matching your keyword.

## Usage

### `Keyword` - Describe action
### `todo DESCRIPTION` - Add ToDo

Adds a new ToDo task with a description.

Example of usage:

`todo write sad poetry`

Expected outcome:

`Nice! I've added the new task for you! Now you have 1 task in the list.`

### `deadline DESCRIPTION /by YYYY-MM-DD HH:MM` - Add Deadline

Adds a new Deadline task with a description and deadline.

Example of usage:

`deadline write love song /by 2020-12-24 23:59`

Expected outcome:

`Nice! I've added the new task for you! Now you have 2 tasks in the list.`

### `event DESCRIPTION /at YYYY-MM-DD HH:MM to YYYY-MM-DD HH:MM` - Add Event

Adds a new Event task with a description and event duration.

Example of usage:

`event attend Golden Globes /at 2021-01-24 19:00 to 2021-01-24 22:30`

Expected outcome:

`Nice! I've added the new task for you! Now you have 3 tasks in the list.`

### `list` - List all tasks

Describe action and its outcome.
Lists all tasks to view them.

Example of usage:

`keyword (optional arguments)`
`list`

Expected outcome:

`outcome`
```
1. [T][✗] write sad poetry
2. [D][✗] write love song (by: Thu, 24 Dec 2020, 23:59)
3. [E][✗] attend Golden Globes (at: Sun, 24 Jan 2021, 19:00 to Sun, 24 Jan 2021, 22:30)
```

### `done TASKNUMBER(s)` - Mark task(s) as done

Marks the task(s) done and changes the according symbol(s) from a cross to a tick.

Example of usage:

`done 1,3`

Expected outcome:

`Nice! I've marked done the task(s) for you!`


### `delete TASKNUMBER(s)` - Delete task(s)

Deletes the task(s) Lana does not have to track anymore.

Example of usage:

`delete 3`

Expected outcome:

`Nice! I've deleted the task(s) for you! Now you have 2 tasks in the list.`

### `find KEYWORD` - Find task(s)

Find task(s) based on keyword.

Example of usage:

`find poetry`

Expected outcome:

`1. [T][✓] write sad poetry`




Binary file added docs/Ui.png.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/main/java/Main.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ public void start(Stage stage) {
Scene scene = new Scene(ap);
stage.setScene(scene);
fxmlLoader.<MainWindow>getController().setDuke(duke);
stage.setTitle("Lana del Taco");
stage.show();
} catch (IOException e) {
e.printStackTrace();
Expand Down
6 changes: 2 additions & 4 deletions src/main/java/MainWindow.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

import javafx.application.Platform;
import javafx.fxml.FXML;
import javafx.scene.control.Button;
import javafx.scene.control.ScrollPane;
import javafx.scene.control.TextField;
import javafx.scene.image.Image;
import javafx.scene.layout.*;
import javafx.scene.layout.AnchorPane;
import javafx.scene.layout.VBox;


/**
Expand All @@ -19,8 +19,6 @@ public class MainWindow extends AnchorPane {
private VBox dialogContainer;
@FXML
private TextField userInput;
@FXML
private Button sendButton;

private Duke duke;

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/Ui.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ public class Ui {
* @return opening string.
*/
public static String opening() {
return "Hello! I'm Duke!\nWhat can I do for you?";
return "Hello! I'm Lana del Taco!\nWhat can I do for you?";
}

/**
Expand Down

0 comments on commit 875cf16

Please sign in to comment.