From 814e55fd43d5e73841d745553e31c0142b9a33ef Mon Sep 17 00:00:00 2001 From: freshcabbage123 Date: Thu, 5 Oct 2023 12:19:03 +0800 Subject: [PATCH] chore: Move changes from draft UG to actual UG --- docs/UserGuide.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 15058263a5f..5bbcbc9edf8 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -85,6 +85,54 @@ Output:
+### 2. Adding a person: `addPerson` + +Add new people that you meet, be it new clients, vendors or friends. + +Format: + +``` +addPerson n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]… +``` + +{% include admonition.html type="info" title="A person can have any number of tags (including 0)." %} + +Examples: + +- `addPerson n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` +- `addPerson n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal` + +Output: + +![addPerson success](images/addPerson_success.png) + +Errors: + +![addPerson error](images/error/addPerson_error.png) + +
+ + +### 3. Listing all persons: `listPerson` + +Presents you with a comprehensive list of contacts in your contact list. + +Format: + +``` +listPerson +``` + +Examples: + +- `listPerson` + +Output: + +![listPerson success](images/listPerson_success.png) + +
+ ### 7. Clearing all person entries: `deleteAllPerson` @@ -110,6 +158,27 @@ Output: ![deleteAllPerson success](images/deleteAllPerson_success.png) +
+ +### 9. Listing all tasks: `listTask` + +Provides you with a complete list of tasks in your task list. + +Format: + +``` +listTask +``` + +Examples: + +- `listTask` + +Output: + +![listTask_success](images/output/listTask_success.png) + +
### 10. Editing a task: `editTask`