diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index c6fa82a0271..3d48e71e7fd 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -205,7 +205,7 @@ In this case, `AddressBookParser` creates `AddCommandParser` to parse user input If any of the above constraints are violated, `AddressBookParser` throws a ParseException. Otherwise, it creates a new instance of `AddCommand` that corresponds to the user input. `AddCommand` comprises of the internship application to be added, which is an instance of `InternshipApplication`. -Upon execution, `AddCommand` first queries the supplied model if it contains a duplicate internship application. If no duplicate internship application exists, `AddCommand` then calls on `model::addItem` to add the internship application into the data. +Upon execution, `AddCommand` first queries the supplied model if it contains a duplicate internship application. If no duplicate internship application exists, `AddCommand` then adds the internship application into the data. ### List all internship applications @@ -323,7 +323,6 @@ The implementation of the command follows the convention of a normal command, wh `AddressBookParser` creates `ExitCommand` Upon execution, `ExitCommand` gets encapsulates the intent to close the application in `CommandResult`. -`MainWindow` checks for the intent via `isExit`, after which, it calls `handleExit` to close the application. > **_NOTE:_** `Model` is not invoked here but included for the sake of clarity. @@ -359,22 +358,23 @@ Upon execution, `ExitCommand` gets encapsulates the intent to close the applicat Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*` -| Priority | As a …​ | I want to …​ | So that …​ | -|----------|-------------------------------|------------------------------------------------------------------|--------------------------------------------------------------------------| -| `* * *` | CS Undergraduate | list all the internship applications | I can view all my past applications | -| `* * *` | Forgetful CS Undergraduate | have a link to HireMe's help page | I can see all the different commands that I can use | -| `* * *` | An efficient CS Undergraduate | type the commands | I do not have to lift my fingers off the keyboard | -| `* * *` | CS Undergraduate | add an internship application | I can add on to the records of all the internships I have applied to | -| `* * *` | CS Undergraduate | delete an internship application | I can remove invalid or irrelevant applications | -| `* * *` | CS Undergraduate | save the internship application data locally | I will not lose my data when I exit the application | -| `* * *` | CS Undergraduate | load the internship from a saved file | I can get back my data when I open the application | -| `* * *` | CS Undergraduate | clear the list of internship application I have saved | I can restart a new list in the next internship application cycle | -| `* * *` | CS Undergraduate | find internship applications by company name | I can quickly locate specific applications for review or updates | +| Priority | As a …​ | I want to …​ | So that …​ | +|----------|-------------------------------|----------------------------------------------------------------------------------|--------------------------------------------------------------------------| +| `* * *` | CS Undergraduate | list all the internship applications | I can view all my past applications | +| `* * *` | Forgetful CS Undergraduate | have a link to HireMe's help page | I can see all the different commands that I can use | +| `* * *` | An efficient CS Undergraduate | type the commands | I do not have to lift my fingers off the keyboard | +| `* * *` | CS Undergraduate | add an internship application | I can add on to the records of all the internships I have applied to | +| `* * *` | CS Undergraduate | delete an internship application | I can remove invalid or irrelevant applications | +| `* * *` | CS Undergraduate | save the internship application data locally | I will not lose my data when I exit the application | +| `* * *` | CS Undergraduate | load the internship from a saved file | I can get back my data when I open the application | +| `* * *` | CS Undergraduate | clear the list of internship application I have saved | I can restart a new list in the next internship application cycle | +| `* * *` | CS Undergraduate | find internship applications by company name | I can quickly locate specific applications for review or updates | | `* * *` | CS Undergraduate | update the status of an internship application to accepted, pending, or rejected | I can update the status of each application accurately | -| `* *` | Meticulous CS Undergraduate | sort the list of internship applications by date of application | I can prioritize follow-ups with older applications | -| `*` | Organised CS Undergraduate | view the interview dates for different internships applications | I can update my schedule accordingly | -| `*` | Efficient CS Undergraduate | view my most desired internship applications by favouriting them | I can prioritize my time on checking up on these internship applications | -| `*` | Forgetful CS Undergraduate | remind myself of acceptance deadline | I will not miss the deadline to accept | +| `* *` | Meticulous CS Undergraduate | sort the list of internship applications by date of application | I can prioritize follow-ups with older applications | +| `* *` | Curious CS Undergraduate | see a chart that summarises the statuses of all my applications | I know know the breakdown of each status | +| `*` | Organised CS Undergraduate | view the interview dates for different internships applications | I can update my schedule accordingly | +| `*` | Efficient CS Undergraduate | view my most desired internship applications by favouriting them | I can prioritize my time on checking up on these internship applications | +| `*` | Forgetful CS Undergraduate | remind myself of acceptance deadline | I will not miss the deadline to accept | *{More to be added}* diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 78dd2023586..8fcb9305930 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -115,9 +115,19 @@ For steps 5 and 6, refer to **either** [Mac Users](#_mac-users_) **or** [Windows Continue to [Using the terminal](#_using-the-terminal_) after completing steps 5 and 6. #### _Mac Users_ -5. Use mac search and type Terminal, click on open. +5. Use mac spotlight search (Command + Space bar) and type Terminal, click on open. + + macsterminal + You will see a window like this. -6. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar hireme.jar` command to run the application.
+ + ![openmacterminal](images/OpenMacTerminal.png) + +6. Click into the folder created in step 3. Left click on the `hireme.jar` file and select `Get Info`. + ![macfilepathinfo](images/Macfilepathinfo.png) + + On the new open that pops up, left click on `Where` and copy the file path. + macfilepath #### _Windows Users_ 5. Use windows search and type Terminal, click on open. @@ -134,6 +144,7 @@ You will see a window like this. - Windows Terminal: ![windowscd](images/Windowscd.png) - Mac Terminal: + ![maccd](images/Maccd.png)
#### _Using the HireMe application_ @@ -213,7 +224,7 @@ Examples: -**Note:** HireMe considers an entry to be a duplicate of all of its fields match **(case-insensitive)** an existing internship application entry. An attempt to add duplicates will result in an error. +Note: HireMe considers an entry to be a duplicate of all of its fields match (case-insensitive) an existing internship application entry. An attempt to add duplicates will result in an error. @@ -301,17 +312,17 @@ Use these commands to update the status of a specified internship application to 5. `/list` followed by `/accept 4` when there are only 3 internship applications returns an error message. --- - - -**Note:**
You can update an application’s status to its current state. For example, using `/accept INDEX` on an already accepted application will keep its status as `ACCEPTED`, `/pending INDEX` on a pending application will keep it as `PENDING`, and `/reject INDEX` on a rejected application will maintain its `REJECTED` status. - -

Before and after images of the first example

Accept-Status-Before Accept-Status-After
+ +Note:
You can update an application’s status to its current state. For example, using `/accept INDEX` on an already accepted application will keep its status as `ACCEPTED`, `/pending INDEX` on a pending application will keep it as `PENDING`, and `/reject INDEX` on a rejected application will maintain its `REJECTED` status. + + +

### Filtering internship applications by status: `/filter` diff --git a/docs/diagrams/AddSequenceDiagram.puml b/docs/diagrams/AddSequenceDiagram.puml index d099dd63324..a23cbd7c83a 100644 --- a/docs/diagrams/AddSequenceDiagram.puml +++ b/docs/diagrams/AddSequenceDiagram.puml @@ -50,13 +50,7 @@ deactivate AddressBookParser LogicManager -> AddCommand : execute(m) activate AddCommand -AddCommand -> Model : hasItem(internship) -activate Model - -Model --> AddCommand -deactivate Model - -AddCommand -> Model : addItem(internship) +AddCommand -> Model : add if it is not a duplicate activate Model Model --> AddCommand diff --git a/docs/diagrams/ExitSequenceDiagram.puml b/docs/diagrams/ExitSequenceDiagram.puml index 957612c043f..dd6c08108f6 100644 --- a/docs/diagrams/ExitSequenceDiagram.puml +++ b/docs/diagrams/ExitSequenceDiagram.puml @@ -2,10 +2,6 @@ !include style.puml skinparam ArrowFontStyle plain -box Ui UI_COLOR_T1 -participant ":MainWindow" as MainWindow UI_COLOR -end box - box Logic LOGIC_COLOR_T1 participant ":LogicManager" as LogicManager LOGIC_COLOR participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR @@ -17,10 +13,7 @@ box Model MODEL_COLOR_T1 participant "m:Model" as Model MODEL_COLOR end box -[-> MainWindow : executeCommand("/exit) -activate MainWindow - -MainWindow-> LogicManager : execute("/exit") +[-> LogicManager : execute("/exit") activate LogicManager LogicManager -> AddressBookParser : parseCommand("/exit") @@ -49,24 +42,10 @@ deactivate CommandResult ExitCommand --> LogicManager : r deactivate ExitCommand -LogicManager --> MainWindow : r +[<--LogicManager : r deactivate LogicManager 'Hidden arrow to position the destroy marker below the end of the activation bar. ExitCommand -[hidden]-> LogicManager destroy ExitCommand -MainWindow -> CommandResult : isExit() -activate CommandResult - -CommandResult --> MainWindow : isExit -deactivate CommandResult - -alt isExit -MainWindow -> MainWindow : handleExit() -activate MainWindow -deactivate MainWindow -end - -[<--MainWindow -deactivate MainWindow @enduml diff --git a/docs/images/MacTerminal.png b/docs/images/MacTerminal.png new file mode 100644 index 00000000000..6e54332a9de Binary files /dev/null and b/docs/images/MacTerminal.png differ diff --git a/docs/images/Maccd.png b/docs/images/Maccd.png new file mode 100644 index 00000000000..5667ac7e242 Binary files /dev/null and b/docs/images/Maccd.png differ diff --git a/docs/images/Macfilepath.png b/docs/images/Macfilepath.png new file mode 100644 index 00000000000..94a5df839d9 Binary files /dev/null and b/docs/images/Macfilepath.png differ diff --git a/docs/images/Macfilepathinfo.png b/docs/images/Macfilepathinfo.png new file mode 100644 index 00000000000..91027edfd3e Binary files /dev/null and b/docs/images/Macfilepathinfo.png differ diff --git a/docs/images/OpenMacTerminal.png b/docs/images/OpenMacTerminal.png new file mode 100644 index 00000000000..e008f050da0 Binary files /dev/null and b/docs/images/OpenMacTerminal.png differ