Skip to content

Commit

Permalink
Merge pull request #178
Browse files Browse the repository at this point in the history
Update command summary in User Guide
  • Loading branch information
JJtan2002 authored Oct 28, 2024
2 parents a1fbd08 + 91234de commit 671b5c1
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you can type fast, GamerBook can get your contact management tasks done faste

## Quick start

1. Ensure you have Java `17` or above installed in your Computer. You can check your Java version by opening a command terminal (e.g. Command Prompt) and typing `java -version`.
1. Ensure you have [Java `17`](https://www.oracle.com/sg/java/technologies/downloads/) or above installed in your Computer. You can check your Java version by opening a command terminal (e.g. Command Prompt) and typing `java -version`.

1. Download the latest `.jar` file from [here](https://github.com/AY2425S1-CS2103T-T12-4/tp/releases).

Expand Down Expand Up @@ -87,17 +87,22 @@ Underneath each suggested command is the syntax for that command and what parame

## Command summary

Action | Format, Examples
-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------
**Help** | `help`
**List** | `list`
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GAME]… [t/TAG]…​` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 g/Overwatch t/friend t/colleague`
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/Game]… [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
**Editgame** | `editgame INDEX g/GAME [u/USERNAME] [s/SKILLLEVEL] [r/ROLE]​`<br> e.g.,`editgame 1 g/Overwatch u/Potato`
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**Clear** | `clear`
**Delete** | `delete INDEX`<br> e.g., `delete 3`

| Action | Format, Examples |
|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Help** | `help` |
| **List** | `list` |
| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GAME]… [t/TAG]… [pt/TIME]…​` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 g/Overwatch t/friend t/colleague pt/2130` |
| **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/Game]… [t/TAG]… [pt/TIME]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]` |
| **EditGame** | `editgame INDEX g/GAME [u/USERNAME] [s/SKILLLEVEL] [r/ROLE]​`<br> e.g.,`editgame 1 g/Overwatch u/Potato` |
| **FavGame** | `favgame INDEX g/GAME`<br> e.g.,`favgame 2 g/Overwatch` |
| **UnFavGame** | `unfavgame INDEX g/GAME`<br> e.g.,`unfavgame 2 g/Overwatch` |
| **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` |
| **FindTime** | `find TIME-TIME [TIME-TIME]`<br> e.g., `findtime 1800-1900 2000-2200 ` |
| **Clear** | `clear` |
| **Delete** | `delete INDEX`<br> e.g., `delete 3` |
| **Save** | `save` |
| **Load** | `load` |
| **Exit** | `exit` |

--------------------------------------------------------------------------------------------------------------------
## Commands
Expand Down

0 comments on commit 671b5c1

Please sign in to comment.