From 94485a08e4cc4825afef95132dc09a031806bd2d Mon Sep 17 00:00:00 2001 From: SJ <122247406+shunjieee@users.noreply.github.com> Date: Thu, 29 Feb 2024 23:42:44 +0800 Subject: [PATCH] Update README.md --- docs/README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 390854f516..14ac8f3e87 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,6 +19,7 @@ List of features supported: * Sort * Exit +--- ### Adding a task: `todo`, `deadline` and `event` There are three types tasks that Xavier supports, to-do, deadline and event. The commands add the respective task to the task list. @@ -35,6 +36,7 @@ Got it. I've added this task: [T][ ] wash dishes Now you have 1 tasks in the list. ``` + **deadline** Format: `deadline /by ` @@ -47,10 +49,10 @@ Got it. I've added this task: [D][ ] CS2103T Quiz 7 (by: Mar 07 2024, 23:59) Now you have 2 tasks in the list. ``` + **event** Format: `event /from /to ` - Example: `event Taylor Swift Concert /from 3/3/2024-1900 /to 3/3/2024-2200` @@ -64,6 +66,7 @@ Now you have 3 tasks in the list. > [!IMPORTANT] > The date-time format **MUST** be in **dd/MM/yyyy-HHmm**. +--- ### Deleting a task: `delete` Format: @@ -79,6 +82,7 @@ Noted, I've removed this task: Now you have 2 tasks in the list. ``` +--- ### Listing all the task in the list: `list` Format: @@ -91,6 +95,7 @@ Here are the tasks in your list: 2. [E][ ] Taylor Swift Concert (from: Mar 03 2024, 19:00 to: Mar 03 2024, 22:00) ``` +--- ### Marking task as done: `mark` Format: @@ -105,6 +110,7 @@ Nice! I've marked this task as done: [D][X] CS2103T Quiz 7 (by: Mar 07 2024, 23:59) ``` +--- ### Unmarking task: `unmark` Format: @@ -119,6 +125,7 @@ OK, I've marked this task as not done yet: [E][ ] Taylor Swift Concert (from: Mar 03 2024, 19:00 to: Mar 03 2024, 22:00) ``` +--- ### Finding tasks in the list: `find` Format: @@ -135,6 +142,7 @@ Here are the matching tasks in your list: > [!NOTE] > `keyword` is case sensitive. +--- ### Sorting the list: `sort` The list will be sorting with the unmark tasks at the top and marked tasks at the bottom. In each section, the tasks will be sorted alphabetically. @@ -149,6 +157,7 @@ Here are the tasks in your list: 2. [D][X] CS2103T Quiz 7 (by: Mar 07 2024, 23:59) ``` +--- ### Exiting the program: `bye` The program will save the list in `./data/data.txt` before exiting. @@ -161,4 +170,4 @@ Example and expected outcome **(only CLI)**: Saving data ... Data saved successfully. :) Bye. Hope to see you again soon! -``` \ No newline at end of file +```