Merge pull request #290 from meowwtama/branch-UpdateUgImages

Branch update UG images

docs/UserGuide.md

@@ -36,17 +36,6 @@ Tailored for fast typists, MyBookshelf can get your contact and borrowing manage
 
 
 6. Type the command into the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
-   Some example commands you can try:
-
-    * `list` : Lists all library users.
-
-    * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Contact List.
-
-    * `delete 1` : Deletes the 1st library user shown in the contact list.
-
-    * `clear` : Delete all library users from the contact list. (Does not clear library book list).
-
-    * `exit` : Exits the application.
 
 
 7. Refer to the [Features](#features) below for details of each command.
@@ -80,6 +69,7 @@ Tailored for fast typists, MyBookshelf can get your contact and borrowing manage
 
 
 * If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
+
 </box>
 
 <box type="info" seamless>
@@ -93,12 +83,12 @@ Tailored for fast typists, MyBookshelf can get your contact and borrowing manage
 
 
 * `PHONE_NUMBER`: The phone number of the library user.
-  * Has a minimum limit of 3 digits.
+  * Requires a minimum of 3 digits.
   * No maximum limit currently set on the phone number.
 
 
 * `EMAIL`: The email address of the library user.
-  * Valid as long as it follows the format of `local-part@domain
+  * Valid as long as it follows the format of `local-part@domain`.
   * `local-part` contains alphanumeric characters and some special characters such as `+`, `_`, `.` and `-`.
   * `local-part` may not start or end with any special characters.
   * `local-part` must be followed with an `@`.
@@ -119,9 +109,9 @@ Tailored for fast typists, MyBookshelf can get your contact and borrowing manage
 
 
 * `INDEX`: The number associated with the position of each library user in the current displayed Contact List.
-  * Assigned to library users based on the order added into the Contact List.
-  * Takes in a **positive integer** (e.g. 1, 2, 3, …​) up to the last `INDEX` in the Contact List.
-  * Can only take up to 2147483647. Refer here for more information.
+  * Assigned to library users based on the order added into the contact list.
+  * Takes in a **positive integer** (e.g. 1, 2, 3, …​) up to the last `INDEX` in the contact list.
+  * Can only take up to 2147483647.
 
 
 * `KEYWORD`: The part of the word you are searching for.
@@ -135,10 +125,9 @@ Tailored for fast typists, MyBookshelf can get your contact and borrowing manage
 
 * `THRESHOLD`: The merit score limit set for each library user.
   * Takes in integer values.
-  * Can only take in values from -2147483648 to 2147483647. Refer here for more information.
-
+  * Can only take in values from -2147483648 to 2147483647.
 
-<box type="info" seamless>
+</box>
 
 ### **Others:**<br>
 
@@ -164,22 +153,32 @@ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​`
 <box type="tip" seamless>
 
 > **Tip:** A user can have any number of tags (including 0).
+
 </box>
 
 <box type="note" seamless>
 
 > **Note:** User with name identical to another user is deemed as a duplicate (case-sensitive), even when other information is different.
+
 </box>
 
 Examples:
-* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
+* `add n/Kokoro Tsurumaki p/980101296 e/kokoro@bandori.com a/311, Hanasakigawa Ave 2, #08-08`
+
+
+![result for 'add Kokoro'](images/cmdimages/addKokoro.png)
+![result for 'add Kokoro result'](images/cmdimages/addresultKokoro.png)
 
 ### Listing all library users : `list`
 
 Displays a list of all library users in the contact list.
 
 Format: `list`
 
+
+![result for 'list'](images/cmdimages/list.png)
+![result for 'list result'](images/cmdimages/listresult.png)
+
 ### Editing a library user : `edit`
 
 Edits an existing library user's personal information from the contact list.
@@ -193,7 +192,16 @@ Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
 * You can remove all the library user’s tags by typing `t/` without specifying any tags after it.
 
 Examples:
-*  `edit 2 n/Betsy Crower e/betsy@example.com t/` Edits the name and email address of the 2nd person to be `Betsy Crower` and `betsy@example.com`, simultaneously clears all existing tags.
+*  `edit 2 n/Mashiro Kurata` edits the name of the 2nd person to be `Mashiro Kurata`.
+
+
+    Before edit:
+![result for 'edit before'](images/cmdimages/editbeforeMashiro.png)
+
+
+    Edit:
+![result for 'edit'](images/cmdimages/editMashiro.png)
+![result for 'edit result'](images/cmdimages/editresultMashiro.png)
 
 ### Locating library users by name: `find`
 
@@ -209,8 +217,9 @@ Format: `find KEYWORD [MORE_KEYWORDS]`
   e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`
 
 Examples:
-* `find alex david` returns `Alex Yeoh`, `David Li`<br>
-  ![result for 'find alex david'](images/findJaneTanResult.png)
+* `find kokoro mashiro` returns `Kokoro Tsurumaki`, `Mashiro Kurata`
+  ![result for 'find'](images/cmdimages/find.png)
+  ![result for 'find result'](images/cmdimages/findresult.png)
 
 ### Deleting a library user : `delete`
 
@@ -224,11 +233,21 @@ Format: `delete INDEX`
 <box type="warning" seamless>
 
 > **Warning:** `delete` removes all the target user's data, including their merit score and borrowing book list.
+
 </box>
 
 Examples:
 * `list` followed by `delete 2` deletes the 2nd user in the contact list.
-* `find Betsy` followed by `delete 1` deletes the 1st user in the results of the `find` command.
+* `find kokoro mashiro` followed by `delete 2` deletes the 2nd user in the results of the `find` command.
+
+
+    Before delete:
+![result for 'delete before'](images/cmdimages/deletebefore.png)
+
+
+    Delete:
+![result for 'delete'](images/cmdimages/delete.png)
+![result for 'delete result'](images/cmdimages/deleteresult.png)
 
 ### Add a book to Library : `addbook`
 
@@ -242,8 +261,8 @@ Examples:
 * `addbook b/Tales of Kokoro` will add a book titled "Tales of Kokoro" into the library.
 
 
-![result for 'addbook b/Tales of Kokoro'](images/cmdimages/addbook Tales of Kokoro.png)
-![result for 'addbook b/Tales of Kokoro'](images/cmdimages/addbook result Tales of Kokoro.png)
+![result for 'addbook b/Tales of Kokoro'](images/cmdimages/addbookTalesofKokoro.png)
+![result for 'addbook b/Tales of Kokoro'](images/cmdimages/addbookresultTalesofKokoro.png)
 
 ### Delete a book from Library : `delbook`
 
@@ -256,14 +275,15 @@ Format: `delbook b/BOOKTITLE`
 <box type="warning" seamless>
 
 > **Warning:** To avoid accidental deletion, `delbook` only removes the first book which matches `BOOKTITLE`, even there are multiple books with identical `BOOKTITLE`.
+
 </box>
 
 Examples:
 * `delbook b/Tales of Kokoro` will remove a book titled "Tales of Kokoro" from the library.
 
 
-![result for 'delbook b/Tales of Kokoro'](images/cmdimages/delbook Tales of Kokoro.png)
-![result for 'delbook b/Tales of Kokoro'](images/cmdimages/delbook result Tales of Kokoro.png)
+![result for 'delbook b/Tales of Kokoro'](images/cmdimages/delbookTalesofKokoro.png)
+![result for 'delbook b/Tales of Kokoro'](images/cmdimages/delbookresultTalesofKokoro.png)
 ### Borrowing a book: `borrow`
 
 Library user borrows a book. A book is removed from the library's book list and added to the library user's book list.
@@ -278,7 +298,7 @@ Examples:
 * `borrow 1 b/Tales of Kokoro` will record the user index 1 borrowing a book titled "Tales of Kokoro".
 
 
-![result for 'borrow b/Tales of Kokoro'](images/cmdimages/borrow Tales of Kokoro.png)
+![result for 'borrow b/Tales of Kokoro'](images/cmdimages/borrowTalesofKokoro.png)
 
 ### Returning a book : `return`
 
@@ -294,7 +314,7 @@ Examples:
 * `return 1 b/Tales of Kokoro` returns a book titled "Tales of Kokoro" from the user at index 1.<br>
 
 
-![result for 'return b/Tales of Kokoro'](images/cmdimages/return Tales of Kokoro.png)
+![result for 'return b/Tales of Kokoro'](images/cmdimages/returnTalesofKokoro.png)
 
 ### Donating a book : `donate`
 
@@ -312,7 +332,7 @@ Examples:
 * `donate 1 b/Tales of Kokoro` will record user index 1 donating a book titled "Tales of Kokoro".
 
 
-![result for 'donate b/Tales of Kokoro'](images/cmdimages/donate Tales of Kokoro.png)
+![result for 'donate b/Tales of Kokoro'](images/cmdimages/donateTalesofKokoro.png)
 
 ### Set the merit score threshold of the library: `limit`
 
@@ -329,24 +349,22 @@ Examples:
 * `limit` will display the current merit score limit.
 
 
-![result for 'limit'](images/cmdimages/limit result.png)
+![result for 'limit'](images/cmdimages/limitresult.png)
 
 
 * `limit -10` will set the merit score limit of the library to -10.
 
 
-![result for 'limit'](images/cmdimages/limit num result.png)
+![result for 'limit'](images/cmdimages/limitnumresult.png)
 
 ### Clearing all entries : `clear`
 
 Clears all entries of library users from the contact list.
 
 Format: `clear`
 
-<box type="note" seamless>
+> **Note:** `clear` only supports clearing all users in the contact list. To clear all books in the library, we can use `delbook` command to clear the books one by one.
 
-**Note:** `clear` only supports clearing all users in the contact list. To clear all books in the library, we can use `delbook` command to clear the books one by one.
-</box>
 
 ### Exiting the program : `exit`