Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@ bin/

/text-ui-test/ACTUAL.TXT
text-ui-test/EXPECTED-UNIX.TXT

*.jar

127 changes: 111 additions & 16 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,125 @@
# Duke User Guide
# Welcome to Lys - Your Personal Task Management Chatbot!
This guide will help you understand how to use **Lys** effectively.

// Update the title above to match the actual product name
---

// Product screenshot goes here
## **Key Features**
Lys allows you to:
- ✅ Add different types of tasks (**ToDo, Deadline, Event**).
- 📋 List all tasks.
- ✔️ Mark tasks as **done** or **not done**.
- ❌ Delete tasks.
- 🔍 Find tasks by keywords.

// Product intro goes here
---

## Adding deadlines
## **Command List**

// Describe the action and its outcome.
### **1️⃣ Adding Tasks**

// Give examples of usage
#### **➤ Adding a ToDo**
- **Command:**
todo TASK

Example: `keyword (optional arguments)`
- **Example:**
todo Assignment

// A description of the expected outcome goes here
- **Output:**
Got it. I've added this task: [T][ ] Assignment Now you have 1 task in the list.

```
expected output
```
#### **➤ Adding a Deadline**
- **Command:**
deadline TASK /by DEADLINE

## Feature ABC
- **Example:**
deadline Quiz /by Sunday 2359

// Feature details
- **Output:**
Got it. I've added this task: [D][ ] Quiz (by: Sunday 2359) Now you have 2 tasks in the list.

#### **➤ Adding an Event**
- **Command:**
event TASK /from START_TIME /to END_TIME

## Feature XYZ
- **Example:**
event Lecture /from Friday 1600 /to 1800

// Feature details
- **Output:**
Got it. I've added this task: [E][ ] Lecture (from: Friday 1600 to: 1800) Now you have 3 tasks in the list.

---

### **2️⃣ Deleting Tasks**
- **Command:**
delete INDEX

- **Example:**
delete 3

- **Output:**
Noted. I've removed this task: [E][ ] Lecture (from: Friday 1600 to: 1800) Now you have 2 tasks in the list.

---

### **3️⃣ Marking / Unmarking Tasks**

#### **➤ Marking a Task as Done**
- **Command:**
mark INDEX

- **Example:**
mark 2

- **Output:**
Nice! I've marked this task as done: [D][X] Quiz (by: Sunday 2359)

#### **➤ Marking a Task as Not Done**
- **Command:**
unmark INDEX

- **Example:**
unmark 2

**output:**
OK, I've marked this task as not done yet: [D][ ] Quiz (by: Sunday 2359)

---

### **4️⃣ Finding Tasks**
- **Command:**
find TASK

- **Example:**
find Quiz

- **Output:**
Here are the matching tasks in your list:

[D][ ] Quiz (by: Sunday 2359)

---

### **5️⃣ Viewing the Task List**
- **Command:**
list

- **Example:**
list

- **Output:**
Here are the tasks in your list:

[T][ ] Assignment
[D][ ] Quiz (by: Sunday 2359)

---

### **6️⃣ Exiting the Program**
- **Command:**
bye

- **Example:**
bye

- **Output:**
Bye. Hope to see you again soon! Process finished with exit code 0
10 changes: 0 additions & 10 deletions src/main/java/Duke.java

This file was deleted.

Loading