Skip to content

Commit

Permalink
Update UserGuide.md
Browse files Browse the repository at this point in the history
  • Loading branch information
YowSiaoKang authored Apr 15, 2024
1 parent 9ce3f83 commit c227b2c
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,16 @@ Key features include:
- Volunteer Work Assignment

---
- Table of Contents

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

Table of Contents
{:toc}

---

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

## Using this Guide

This user guide (UG) is your companion in **unlocking the full potential** of Match. It’s here to help you understand the app and leverage its features to manage your volunteers like never before.
Expand Down Expand Up @@ -53,6 +59,8 @@ The following glossary clarifies commonly-used terminology:
| Case-insensitive | Casing of alphabetic characters doesn't matter (e.g., “john” = “JOHN”). |
| Contact card | Box displaying each volunteer's details. |

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

## Quick start

1. Ensure you have Java `11` or above installed in your Computer for the magic to work :magic_wand:.
Expand All @@ -69,7 +77,7 @@ The following glossary clarifies commonly-used terminology:
cd "C:\Users\John\My favourite location"
java -jar match.jar
```
5. **For Linux:penguin: /macOS:apple: users:**
5. **For Linux:penguin: / macOS:apple: users:**
1. Open up the search utility by pressing on the `Command` + `Space bar` key and type `Terminal`.
2. Run `cd [JAR file location]` then run `java -jar match.jar` command to open up app.<br>
Example:
Expand Down Expand Up @@ -199,7 +207,7 @@ What you should see:

### Editing a volunteer : `edit`

Looks like someone changed their information, quick don't let the boss find out :fearful:. Use this to edit an existing volunteer in the volunteer contacts.
Looks like someone changed their information, did they finally admit their phone number isn’t ‘12345678’? :relieved: Use this to edit an existing volunteer in the volunteer contacts.

Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/AVAILABILITY]… [t/TAG]…​`
- Edits the volunteer at the specified `INDEX`. The index refers to the index number shown in the displayed volunteer list. The index **must be a positive integer** 1, 2, 3, …​
Expand Down Expand Up @@ -418,7 +426,7 @@ Similar to removing availabilities, refresh will cascade delete all assignments
### Copying emails : `copy`
Remember the good ol `Ctrl` + `c`? Copies the email addresses of all volunteers in the currently filtered volunteer list to the clipboard.
Remember the good old `Ctrl` + `c`? Copies the email addresses of all volunteers in the currently filtered volunteer list to the clipboard.
Format: `copy`
- The email addresses will be copied in a comma-separated format, e.g. `[email protected], [email protected], ...`.
Expand Down Expand Up @@ -523,8 +531,6 @@ Furthermore, certain edits can cause the Match to behave in unexpected ways (e.g

---

<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 Down

0 comments on commit c227b2c

Please sign in to comment.