Skip to content

Commit

Permalink
Update UserGuide.md
Browse files Browse the repository at this point in the history
  • Loading branch information
simkianseng authored Apr 15, 2024
1 parent e23387f commit d47d366
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@ title: User Guide

<br>

Welcome to Match!
Welcome to Match :mage:!

Your premier **desktop app for volunteer coordinators** to keep track of volunteer contacts as well as assign volunteering assignments to them.

We are **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.

Master the wand and become the ultimate task wizard :mage:.

Key features include:
- Fast Volunteer Addition
- Effortless Editing
Expand Down Expand Up @@ -78,6 +80,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:**
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>
Expand Down Expand Up @@ -153,6 +156,8 @@ Assignments tab is the alternate tab that displays all assignments :briefcase:.

</div>

<font color="green"> === Now let us begin your wizardry journey as you acquire new spells to slay the work monsters :space_invader:. === </font>

### Adding a volunteer: `add`

Never lose count of your volunteers :muscle:, add a volunteer to your volunteer contacts.
Expand Down Expand Up @@ -529,6 +534,8 @@ If your changes to the data file makes its format invalid, Match will discard al
Furthermore, certain edits can cause the Match to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
</div>

<font color="green"> === Congratulations you have mastered all the elements you are now a qualified wizard :mage:! === </font>

## FAQ

**Q**: How do I transfer my data to another Computer?<br>
Expand Down

0 comments on commit d47d366

Please sign in to comment.