### Part 2: Using the HireMe application + For steps 5 and 6, refer to **either** [Mac Users](#mac-users) **or** [Windows Users](#windows-users) section that matches your computer system. Continue to [Using the terminal](#using-the-terminal) after completing steps 5 and 6.
-#### _Mac Users_ +#### _Mac users_ 5. Use mac spotlight search (Command + Space bar) and type Terminal, click on open.
@@ -132,21 +133,23 @@ Continue to [Using the terminal](#using-the-terminal) after completing steps 5 a
6. Click into the folder created in step 3. Left click on the `hireme.jar` file and select `Get Info`.
- On the new open that pops up, left click on `Where` and copy the file path.
+ On the new window that pops up, left click on `Where` and copy the file path.
-#### _Windows Users_ -7. Use windows search and type Terminal, click on open. +#### _Windows users_ +5. Use windows search and type Terminal, click on open. 
You will see a window like this.  -8. Click into the folder created in step 3. Click on the empty space of the bar located at the top and copy the file path. +6. Click into the folder created in step 3. Click on the empty space of the bar located at the top and copy the file path.  - _file path here is highlighted in blue_ +
#### _Using the terminal_ @@ -165,16 +168,16 @@ You will see a window like this. #### _Using the HireMe application_ -A GUI similar to the below should appear in a few seconds. It is encouraged to expand the window to full screen for better viewability. Note how the app contains some sample data.
+A GUI similar to the below should appear in a few seconds. It is encouraged to **expand the window to full screen** for better viewability. Note how the app contains some sample data.
 9. Type the command in the command box and press Enter to execute it. (e.g. typing **`/help`** and pressing Enter will open the help window.)
Some example commands you can try: - * `/add n/Google r/Software Engineer Intern e/google@gmail.com d/16/09/24` : Adds an internship application at Google to HireMe. + * `/add n/Google r/Software Engineer Intern e/google@gmail.com d/16/09/24`: Adds an internship application at Google to the list of added entries. - * `/delete 1` : Deletes the 1st internship application shown in the displayed list. + * `/delete 1` : Deletes the first internship application shown in the displayed list. * `/list` : Lists all your internship applications. @@ -185,7 +188,8 @@ A GUI similar to the below should appear in a few seconds. It is encouraged to e * `/exit` : Exits the app. -Refer to the [Features](#features) below for more details of each command. Check [Troubleshooting](#troubleshooting) if you are facing problems for setting up. +Refer to the [Features](#features) below for more details of each command.
+Refer to [Troubleshooting](#troubleshooting) if you are facing problems for setting up. -------------------------------------------------------------------------------------------------------------------- @@ -224,9 +228,9 @@ Adds your internship application to HireMe with required details such as company Format: `/add n/COMPANY_NAME r/ROLE e/EMAIL d/DATE` -* `NAME` must be alphanumeric but these special characters `_`,`&`,`/`,`.`,`:`,`(`, and `)` can also be used. -* `ROLE` must be alphanumeric but these special characters `/` can also be used. -* `EMAIL` must be a valid email address. +* `NAME` can only contain alphanumeric or special characters like `_`,`&`,`/`,`.`,`:`,`(`, and `)`. +* `ROLE` can only contain alphanumeric or `/`. +* `EMAIL` must be a [valid email address](#faq). * The `DATE` must be within the year 2000 and the current year. It also cannot be a future date which means that the date used must be before today or today's date. * It must be in the format `dd/mm/yy`, and each field must be double digits (e.g. 01 is valid while 1 is not) @@ -315,9 +319,9 @@ Format: `/accept INDEX`, `/reject INDEX`, `/pending INDEX` * `/accept INDEX`: Changes the status of the application at index `INDEX` in the displayed list to `ACCEPTED`. * `/pending INDEX`: Changes the status of the application at index `INDEX` in the displayed list to `PENDING`. * `/reject INDEX`: Changes the status of the application at index `INDEX` in the displayed list to `REJECTED`. -* The `INDEX` refers to the position of the application in the current displayed list. The index is relative to the list shown on the screen after filtering or listing commands. -- `INDEX` **must be a positive integer** (e.g., 1, 2, 3, …). -- `INDEX` **must be a valid number** for the displayed list length (e.g., `/reject 5` is invalid if there are fewer than 5 applications in the displayed list). +* The `INDEX` refers to the position of the application in the current displayed list. The index is relative to the list shown on the screen after filtering or listing commands. +* `INDEX` **must be a positive integer** (e.g., 1, 2, 3, …). +* `INDEX` **must be a valid number** for the displayed list length (e.g., `/reject 5` is invalid if there are fewer than 5 applications in the displayed list). **Important:** Commands like `/accept`, `/pending`, and `/reject` work on the displayed list, not the entire application database. For example, if you have 10 total applications, but after using `/filter ACCEPTED` only 5 applications are shown, then `/reject 5` will target the last item on this filtered list. @@ -328,16 +332,14 @@ Format: `/accept INDEX`, `/reject INDEX`, `/pending INDEX` 4. `/filter PENDING` followed by `/accept 1`: Updates the status of the 1st application on the filtered list (currently `PENDING`) to `ACCEPTED`, removing it from the list view as it no longer matches the `pending` filter. 5. `/list` followed by `/accept 4` when there are only 3 internship applications returns an error message. - -
These are the before and after images of the first example
@@ -499,3 +501,30 @@ Action | Format, Examples **Clear** | `/clear` **Chart** | `/chart` **Exit** | `/exit` + +-------------------------------------------------------------------------------------------------------------------- + +## Glossary + +- **Application Status**: + - **PENDING**: The internship application is currently in progress. + - **REJECTED**: The user has rejected or been rejected from this internship application. + - **ACCEPTED**: The user has accepted the offer for this internship. + +- **Action**: The task carried out by the HireMe application such as Add, Delete, Update entries. + +- **Command Line Interface (CLI)**: The user interacts with the computer by typing text commands instead of using a mouse to click on buttons or icons. As if giving instructions to execute a desired action. + +- **Command**: The string the user types into the HireMe application’s command bar to carry out a particular action. + +- **Command Bar**: The input bar at the top of the HireMe application which allows users to type in a string command. + +- **Company Email**: The email of the company that the user is applying for an internship role at. + +- **Company Name**: The name of the company that the user is applying for an internship role at. + +- **Graphical User Interface (GUI)**: The user interacts with the computer using visual elements like buttons, icons and windows. + +- **Role**: The role of the internship the user applied for. + +- **Index**: The index of the internship application displayed in the list. diff --git a/docs/images/Macfilepath.png b/docs/images/Macfilepath.png index 94a5df839d9..58d11023506 100644 Binary files a/docs/images/Macfilepath.png and b/docs/images/Macfilepath.png differ