Update DG User Story, About Us Gambe page, User Guide User section, Raeadme image

docs/AboutUs.md

@@ -38,15 +38,14 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 * Role: Member
 
-### Jean Doe
+### Julius Gambe
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/juliusgambe.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/juliusgambe)]
+[[portfolio](team/juliusgambe.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
 
 ### James Doe
 

docs/UserGuide.md

@@ -4,99 +4,94 @@ This comprehensive user guide is your key to a seamless start with our cutting-e
 home-based businesses. Our solution is tailored to enhance the efficiency of managing delivery addresses, simplifying
 your operations. Within these pages, you'll find detailed coverage of the following essential topics:
 
-* Getting Started
-* Features
-    * User
-        * Secure account with a password
-        * Login
-        * Logout
-        * Register
-        * Recover password
-    * Customer
-        * Add customer
-        * List customers
-        * Update customer details
-        * Delete customer
-    * Delivery
-        * Create delivery
-        * View all deliveries
-        * Sorted deliveries
-        * View details of a delivery
-        * Update details of a delivery
-        * Delete delivery
-* Troubleshooting / FAQ
-
-#          
+- Getting Started
+- Features
+    - User
+        - Secure account with a password
+        - Login
+        - Logout
+        - Register
+        - Recover password
+    - Customer
+        - Add customer
+        - List customers
+        - Update customer details
+        - Delete customer
+    - Delivery
+        - Create delivery
+        - View all deliveries
+        - Sorted deliveries
+        - View details of a delivery
+        - Update details of a delivery
+        - Delete delivery
+- Troubleshooting / FAQ
+
+#
 
 # Getting Started
 
 To get started, you will need to create an account and download the software. Once you have done that, you can follow
 the instructions in the Getting Started Guide to start using the software.
 
-#          
+#
 
 # Features
 
-*[ ] specifies optional fields
+\*[ ] specifies optional fields
 
 ## <span style="text-decoration:underline;">User</span>
 
-### Login
-
-**Format: `login --user USERNAME --password PASSWORD`**
+### Register
 
-**Example: `login --user gabriel --password gabrielIsGreat`**
+**Format: `register --user USERNAME --password PASSWORD --confirmPass CONFIRM_PASSWORD`**
 
-![drawing](https://docs.google.com/drawings/d/12345/export/png)
+**Example: `register --user gabriel --password gabrielIsGreat --confirmPass gabrielIsGreat`**
 
-**Accepted Values: **
+**Accepted Values:**
 
-    _USERNAME:_ String
+_USERNAME:_ String
 
+_PASSWORD:_ String
 
-    _PASSWORD:_ String
+_CONFIRM PASSWORD:_ String that is the same as PASSWORD.
 
-**Command succeeds: _Log in successful._**
+**Command succeeds: _Register successful._**
 
 **Command fails (missing fields): _Please fill up all the required fields._**
 
-**Command fails (wrong login credentials):_ Wrong username and/or password. Try again. _**
-
-### Logout
-
-**Format: `logout`**
+**Command fails (password does not match): _Passwords do not match. Try again._**
 
-**Example: `logout`**
-
-![drawing](https://docs.google.com/drawings/d/12345/export/png)
+### Login
 
-**Command succeeds: _Logout successful._**
+**Format: `login --user USERNAME --password PASSWORD`**
 
-### Register
+**Example: `login --user gabriel --password gabrielIsGreat`**
 
-**Format: `register --user USERNAME --password PASSWORD --confirmPass CONFIRM_PASSWORD`**
+**Accepted Values:**
 
-**Example: `register --user gabriel --password gabrielIsGreat --confirmPass gabrielIsGreat`**
+_USERNAME:_ String
 
-![drawing](https://docs.google.com/drawings/d/12345/export/png)
+_PASSWORD:_ String
 
-**Accepted Values: **
+**Command succeeds: _Log in successful._**
 
-    _USERNAME:_ String
+**Command fails (missing fields): _Please fill up all the required fields._**
 
+**Command fails (wrong login credentials): _Wrong username and/or password. Try again._**
 
-    _PASSWORD:_ String
+### Forget Password [coming soon]
 
+### Logout
 
-    _CONFIRM PASSWORD:_ String that is the same as PASSWORD.
+**Format: `logout`**
 
-**Command succeeds: _Register successful._**
+**Example: `logout`**
 
-**Command fails (missing fields): _Please fill up all the required fields._**
+**Command succeeds: _Logout successful._**
 
-**Command fails (password does not match):_ Passwords do not match. Try again. _**
+### Change Password [coming soon]
 
-##          
+### Delete Account [coming soon]
 
 ## <span style="text-decoration:underline;">Customer</span>
 
@@ -106,7 +101,7 @@ Adds a customer to the address book.
 
 **Format: `customer add --name NAME --phone PHONE_NUMBER --email EMAIL --address ADDRESS`**
 
-**Example: <code>customer add --name Gabriel --phone 8765 4321
+\*\*Example: <code>customer add --name Gabriel --phone 8765 4321
 --email [[email protected]](mailto:[email protected]) --address RVRC Block B</code></strong>
 
 **Accepted Values:**
@@ -153,26 +148,22 @@ Updates the personal details of an existing customer in the address book.
 
 **Format**: `customer edit CUSTOMER_ID [--name NAME] [--phone PHONE_NUMBER] [--email EMAIL] [--address ADDRESS]`
 
-**Example**: `customer edit 1001 --name Gabriel -–phone 1234 5678 --email [email protected] --address RVRC Block B Ben's Room`
+**
+Example**: `customer edit 1001 --name Gabriel -–phone 1234 5678 --email [email protected] --address RVRC Block B Ben's Room`
 
 **Accepted Values:**
 
 _NAME_: String
 
-
 _PHONE_NUMBER_: 8 digit Integer
 
-
 _EMAIL_: String with @ and . in valid email format
 
-
 _ADDRESS_: String
 
-
 _CUSTOMER_ID_: Integer
 
-
-*At least one of the optional fields must be provided.
+\*At least one of the optional fields must be provided.
 
 **Command succeeds:** _Customer 1, Gabriel has been updated!_
 
@@ -216,10 +207,8 @@ Creates a delivery.
 
 _DELIVERY_NAME:_ String of 50 characters
 
-
 _CUSTOMER_ID:_ Integer
 
-
 _DATE:_ YYYY-MM-DD format
 
 **Command succeeds:** _Delivery [1001] furniture created successfully for Customer 1, Gabriel!_
@@ -240,15 +229,15 @@ Shows a list of all deliveries.
 
 **Accepted Values:**
 
-_    STATUS_: all or pending or complete
+_ STATUS_: all or pending or complete
 
-	_SORT: _asc for ascending or desc for descending. If unspecified, default to sort by delivery date. 
+    _SORT: _asc for ascending or desc for descending. If unspecified, default to sort by delivery date.
 
 **Command succeeds (>0 deliveries):**
 
 _Here are all the deliveries:_
 
-1. [1001] Gabriel’s Milk - Completed - Ordered 20th Sept 2023  : Delivered on 30th Sept 2023
+1. [1001] Gabriel’s Milk - Completed - Ordered 20th Sept 2023 : Delivered on 30th Sept 2023
 2. [1002] Gambe’s Meat - Completed - Ordered 22th Sept 2023 : Delivered on 29th Sept 2023
 3. [1003] Ben’s Coffee - Pending - Ordered 25th Sept 2023 : Delivery on 1st October 2023
 
@@ -291,9 +280,9 @@ _DELIVERY_ID_: Integer
 
 ### Update delivery status and date
 
-* Mark delivery as complete
-* Mark delivery as pending
-* Change date of delivery
+- Mark delivery as complete
+- Mark delivery as pending
+- Change date of delivery
 
 #### Mark delivery as complete
 
@@ -307,13 +296,13 @@ _DELIVERY_ID_: Integer
 
 **Command succeeds:** _Delivery [1001] Gabriel’s Milk marked as pending! _
 
-**Command failed (delivery_name missing): _Please specify a delivery name to delete!_**
+**Command failed (delivery*name missing): \_Please specify a delivery name to delete!***
 
 **Command failed (delivery_name not in database):** _This delivery does not seem to exist!_
 
 **Command failed (delivery already complete): _This delivery is already marked as complete._**
 
-####          
+####
 
 #### Mark delivery as pending
 
@@ -352,7 +341,7 @@ _DELIVERY_ID_: Integer
 
 **Command failed (invalid date format): _Please format date as YYYY-MM-DD. _**
 
-**Command failed (delivery_name not in database): _This delivery does not seem to exist!  _**
+**Command failed (delivery*name not in database): \_This delivery does not seem to exist! ***
 
 ### Delete delivery
 
@@ -370,19 +359,24 @@ _DELIVERY_ID_: Integer
 
 **Command failed (delivery_name missing):** _Please specify a delivery name to delete!_
 
-**Command failed (delivery_name not in database): _This delivery does not seem to exist_**
+**Command failed (delivery*name not in database): \_This delivery does not seem to exist***
 
 ### Create a note for a delivery `[coming soon in v1.3]`
-*Details coming soon...*
+
+_Details coming soon..._
 
 ### View deliveries for the day `[coming soon in v1.3]`
-*Details coming soon...*
+
+_Details coming soon..._
 
 ### Add customer data to delivery `[coming soon in v1.3]`
-*Details coming soon...*
+
+_Details coming soon..._
 
 ### Remove customer from delivery `[coming soon in v1.3]`
-*Details coming soon...*
+
+_Details coming soon..._
 
 ### Look up delivery details `[coming soon in v1.3]`
-*Details coming soon...*
+
+_Details coming soon..._

docs/team/juliusgambe.md

@@ -0,0 +1,14 @@
+---
+layout: default.md
+title: "Julius Gambe's Project Portfolio Page"
+---
+
+### Project: HomeBoss
+
+HomeBoss is a desktop application used for managing deliveries for home business owners.
+The user interacts with it using a CLI, and it has a GUI created with JavaFX.
+It is written in Java, and has about 10 kLoC.
+
+Given below are my contributions to the project.
+
+*to be added soon*