Skip to content

Commit

Permalink
Update user guide images
Browse files Browse the repository at this point in the history
  • Loading branch information
STELLA-LYE committed Mar 21, 2024
1 parent 74164ec commit f45d75c
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 7 deletions.
13 changes: 7 additions & 6 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ TutorsContactsPro is a **desktop app for tutors teaching Computer Science course

4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.<br>
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
![Ui](images/Ui.png)
![Ui](images/UpdatedUi.png)

4. 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.<br>
Some example commands you can try:
Expand Down Expand Up @@ -137,7 +137,8 @@ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL y/YEAR m/MAJOR tg/TELEGRAM_HANDLE [r/

Examples:
* `add n/John Doe p/98765432 e/[email protected] y/2 m/Computer Science tg/johndoe r/Very quiet student g/TUT04 g/LAB10 `

* `add n/Kendra Huetta p/98765367 e/[email protected] y/1 m/Computer Science tg/KendraHuetta r/quiet student g/LAB10 `
![result for 'add Kendra Huetta'](images/addFeature.png)

### <span id='feature-edit'> Editing a student : `edit` <span>

Expand Down Expand Up @@ -171,8 +172,8 @@ Format: `find KEYWORD [MORE_KEYWORDS]`

Examples:
* `find John` returns `john` and `John Doe`
* `find ale` returns `Alex Yeoh`, `Alexia Li`<br>
![result for 'find alex david'](images/findAlexDavidResult.png)
* `find Jo` returns `John Doe`, `Johan Louis`<br>
![result for 'find Jo'](images/findFeature.png)

### <span id='feature-filter'> Filtering students using group: `filter` <span>

Expand All @@ -188,8 +189,8 @@ Format: `filter KEYWORD [MORE_KEYWORDS]`
e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`

Examples:
* `filter TUT01 ` returns `john` and `John Doe` belonging to the tutorial group `TUT01`
![result for 'find alex david'](images/findAlexDavidResult.png)
* `filter TUT04 ` returns `John Doe` and `Johan Louis` belonging to the tutorial group `TUT04`
![result for 'filter TU'](images/filterFeature.png)


### <span id='feature-delete'> Deleting a student : `delete` <span>
Expand Down
Binary file added docs/images/UpdatedUI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/addFeature.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/filterFeature.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/findFeature.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/main/resources/view/MainWindow.fxml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
<padding>
<Insets bottom="10" left="10" right="10" top="10" />
</padding>
<StackPane fx:id="personListPanelPlaceholder" VBox.vgrow="ALWAYS" />
<StackPane fx:id="personListPanelPlaceholder" VBox.vgrow="ALWAYS" style="-fx-background-color: #104A53;"/>
</VBox>
</SplitPane>

Expand Down

0 comments on commit f45d75c

Please sign in to comment.