Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add screnshots to UG #102

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 40 additions & 8 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ title: User Guide

Match is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Match can get your contact management tasks done faster than traditional GUI apps.

- Table of Contents
{:toc}
* Table of Contents
{:toc}

---

<div style="page-break-after: always;"></div>

## Quick start

1. Ensure you have Java `11` or above installed in your Computer.
Expand Down Expand Up @@ -39,6 +41,8 @@ Match is a **desktop app for managing contacts, optimized for use via a Command

---

<div style="page-break-after: always;"></div>

## Features

<div markdown="block" class="alert alert-info">
Expand Down Expand Up @@ -79,6 +83,9 @@ Examples:
- `add n/John Doe p/98765432 e/[email protected] a/22/05/2024`
- `add n/Betsy Crowe t/friend e/[email protected] a/25/05/2024 p/1234567 t/criminal`

What you should see:
![add](images/features/add.png)

### Editing a person : `edit`

Edits an existing person in the address book.
Expand Down Expand Up @@ -112,6 +119,9 @@ Examples:
- `addavail 1 a/01/01/2024`
- `addavail 2 a/02/03/2024 a/03/03/2024`

What you should see:
![addavail](images/features/addavail.png)

### Removing availabilities : `removeavail`

Removes availabilities from the address book.
Expand All @@ -127,12 +137,18 @@ Format: `removeavail INDEX a/AVAILABILITY`
In this version of Match, removing an availability will not delete his/her assignments on that day.
</div>

What you should see:
![removeavail](images/features/removeavail.png)

### Listing all persons : `list`

Shows a list of all persons in the address book.

Format: `list`

What you should see:
![list](images/features/list.png)

### Locating persons by name: `find`

Find people whose names contain any of the given name, availability or keywords.
Expand All @@ -152,6 +168,9 @@ Examples:
* `find a/23/05/2024` returns people who are available on 23/05/2024
* find a/23/05/2024 a/24/05/2024 returns people who are available on either 23/05/2024 or 24/05/2024

What you should see:
![find](images/features/find.png)

### Deleting a person : `delete`

Deletes the specified person from the address book.
Expand All @@ -162,9 +181,7 @@ Format: `delete INDEX`

**:information_source: Take note:**<br>

- As delete is deemed as a critical operation, you will see a confirmation message shown below.

![delete confirmation](./images/features/DeleteConfirmation.gif)
- As delete is deemed as a critical operation, you will see a confirmation message.

- Do not panic, entering `y` following it will delete proceed to delete the specified entry, while entering anything else will default to cancelling the operation.

Expand Down Expand Up @@ -222,6 +239,10 @@ Examples:
- `assign 1 d/Tutoring a/01/01/2024`
- `assign 2 d/Elderly Care a/02/03/2024`

What you should see:
![assign](images/features/assign.png)
![lista](images/features/lista.png)

### Listing all assignments : `lista`

Shows a list of all assignments in the address book.
Expand All @@ -230,6 +251,8 @@ Shows a list of all assignments in the address book.
To switch back to volunteer list, type `list`
</div>

What you should see: [here](UserGuide.md/#assigning-volunteers--assign)

### Remove assignments : `removeassign`

Removes an assignment from the assignment list.
Expand Down Expand Up @@ -269,6 +292,9 @@ Examples:
- `list` followed by `copy` copies all email addresses in the address book.
- `find n/john` followed by `copy` copies the email addresses of people whose names contain "john".

What you should see:
![copy](images/features/copy.png)

### Exporting to CSV: `export`

Exports data to a comma-separated values (CSV) file located at `[JAR file location]/data`. Both persons and assignments are exported as `persons.csv` and `assignments.csv` respectively.
Expand All @@ -289,7 +315,7 @@ Exports data to a comma-separated values (CSV) file located at `[JAR file locati

Shows a message explaning how to access the help page.

![help message](images/helpMessage.png)
![add](images/features/help.jpg)

Format: `help`

Expand Down Expand Up @@ -329,13 +355,17 @@ _Details coming soon ..._

---

<div style="page-break-after: always;"></div>

## FAQ

**Q**: How do I transfer my data to another Computer?<br>
**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Match home folder.

---

<div style="page-break-after: always;"></div>

## Known issues

1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again.
Expand All @@ -344,6 +374,8 @@ _Details coming soon ..._

---

<div style="page-break-after: always;"></div>

## Command summary

Action | Format, Examples
Expand All @@ -356,9 +388,9 @@ Action | Format, Examples
**Find** | `find KEYWORD [n/NAME] [a/AVAILABILITY] [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**Delete**[^1] | `delete INDEX`<br> e.g., `delete 3`
**Clear**[^1] | `clear`
**Assign** | `assign INDEX d/ASSIGNMENT_DETAILS a/AVAILABILITY`
**Assign** | `assign INDEX d/ASSIGNMENT_DETAILS a/AVAILABILITY`<br> e.g., `assign 1 d/Food Distribution a/01/01/2024`
**List Assignments** | `lista`
**Remove Assignments** | `removeassign INDEX`
**Remove Assignments** | `removeassign INDEX`<br> e.g. `removeassign 1`
**Refresh** | `refresh`
**Copy** | `copy`
**Export** | `export`
Expand Down
Binary file removed docs/images/features/DeleteConfirmation.gif
Binary file not shown.
Binary file added docs/images/features/add.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/features/addavail.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/features/assign.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/features/clear-confirmation-n.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/features/clear-confirmation-y.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/features/clear-confirmation.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/features/clipboard.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/features/command-history.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/features/copy.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/features/export.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/features/find.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/features/help.jpg
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/features/list.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/features/lista.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/features/removeavail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading