diff --git a/docs/UserGuide.md b/docs/UserGuide.md index cf299595a6..36698693ba 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -14,7 +14,6 @@ Optimized for a Command Line Interface (CLI), CareContacts is ideal for fast typ -------------------------------------------------------------------------------------------------------------------- -
## Quick start @@ -45,7 +44,6 @@ Optimized for a Command Line Interface (CLI), CareContacts is ideal for fast typ 1. Refer to the [Features](#features) below for details of each command. -------------------------------------------------------------------------------------------------------------------- -
## Features @@ -74,8 +72,6 @@ Optimized for a Command Line Interface (CLI), CareContacts is ideal for fast typ -
- ### Viewing help : `help` Shows a help window with a small set of essential commands to help new users get started quickly. @@ -90,8 +86,6 @@ Format: `help` ![help message](images/helpWindow.png) -
- ### Adding a person: `add` Adds a student to the address book. @@ -138,8 +132,6 @@ Examples that will **NOT** trigger a warning: -
- ### Listing all persons : `list` Shows a list of all persons in the address book. @@ -152,8 +144,6 @@ Format: `list [n/] | [a/] | [pn/] | [pc/] | [pe/]` * Alphabetical sort is applied to `n/`, `pn/` and `pe/`. * Numeric sort in ascending order is applied to `a/` and `pc/`. -
- ### Editing a person : `edit` Edits an existing person in the address book. @@ -171,8 +161,6 @@ Examples: * `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags. * `edit 3 pc/91234567 pe/johndoe@example.com` Edits the phone number and email address of the 3rd person's parent to be `91234567` and `johndoe@example.com` respectively. -
- ### Locating persons by name: `find` Filter students based on matching keywords to specified fields. @@ -203,8 +191,6 @@ Examples: * `find n/Jacob pn/Madison` returns students whose name contains `Jacob` and students whose parent's name contains `Madison` * `find n/Alice pn/Tan a/12` returns all students named `Alice`, and students whose parent's name contains `Tan`, and students who are exactly 12 years old. -
- ### Deleting a student : `delete` Deletes the specified student from the address book. @@ -223,8 +209,6 @@ Examples: * `list` followed by `delete 2` deletes the 2nd person in the address book. * `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. -
- ### Adding or removing a remark from a student : `remark` Adds a remark to the specified student from the address book. @@ -243,8 +227,6 @@ Examples: * `remark 1 r/enjoys sports d/allergic to shellfish c/1C b/very energetic` adds the following remarks to the student at index 1 -
- ### Importing students : `import` Imports students from a CSV file into the address book. @@ -274,30 +256,22 @@ Examples: * `import data/contacts.csv` * `import "data/term 2/students.csv"` -
- ### Clearing all entries : `clear` Clears all entries from the address book. Format: `clear` -
- ### Exiting the program : `exit` Exits the program. Format: `exit` -
- ### Saving the data CareContacts data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. -
- ### Importing the data Use the `import` command to load students from a CSV file: @@ -306,14 +280,10 @@ Use the `import` command to load students from a CSV file: Refer to [Importing students : `import`](#importing-students-import) for the required CSV format. -
- ### Editing the data file CareContacts data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. -
- **Caution:**