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

Modify UserGuide #251

Merged
merged 1 commit into from
Apr 12, 2024
Merged
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
20 changes: 13 additions & 7 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,16 @@ It's optimized for use via a Command Line Interface (CLI) while still having the

## Quick start

1. Ensure you have Java `11` or above installed in your Computer.
1. Ensure you have Java `11` or above installed in your Computer. [How to check](https://www.baeldung.com/java-check-is-installed)
- If you do not have Java `11`, download it from [here](https://www.oracle.com/java/technologies/javase/jdk11-archive-downloads.html)
- Help with configuring correct Java version: [Windows](https://www.happycoders.eu/java/how-to-switch-multiple-java-versions-windows/) | [MacOS](https://stackoverflow.com/questions/21964709/how-to-set-or-change-the-default-java-jdk-version-on-macos) | [Linux](https://www.baeldung.com/linux/java-choose-default-version)
- For Mac users, you are recommended to follow this [guide](https://nus-cs2103-ay2324s2.github.io/website/admin/programmingLanguages.html#programming-language) if you face issues running the `tether.jar` file, notably unreadable or garbled text in the application.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps this can come first? So mac users download the right Java 11 from the start


1. Download the latest `tether.jar` from [here](https://github.com/AY2324S2-CS2103T-F11-3/tp/releases/tag/v1.3).

1. Copy the file to the folder you want to use as the _home folder_ for your Tether.
1. Copy the downloaded file to the folder you want to use as the _home folder_ for Tether.

1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar tether.jar`
1. Double click the `tether.jar` file. Alternatively, for users with command line experience, open up your favourite command terminal, `cd` into the folder you put the jar file in, and use the `java -jar tether.jar`
command to run the application.<br><br>
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>

Expand Down Expand Up @@ -249,25 +252,28 @@ To find a person or persons, execute `find_[email/name/phone] [keyword 1]...` su

Assume that the above list reflects the current data present in Tether for the upcoming example commands.

Multiple matching entries:
**Multiple matching entries:**
Executing `find_name Alice` will list all entries with the name `Alice` even if it is not a full name as stated earlier as seen below:

![img.png](images/find-command/findnamesuccess.png)

Keyword has to be complete:
**Keyword has to be complete:**
Executing `find_name Ali` will not display any matching entries even though `Ali` is a substring of `Alice`.
`0 persons listed!` is the response for such cases of no matching entries as seen below:

![img.png](images/find-command/nomatches.png)

Nonsense keyword inputs:
**Nonsense keyword inputs:**
Executing `find_email 123456` will likewise result in no matching entries. Not that while the value `123456` is not a valid `email`, the command still accepts it and just displays no matching entries. Result display is similar to above

Multiple Keywords:
**Multiple Keywords:**
Executing `find_phone 123 23456` will display the entries that have `123` or `23456` as their phone numbers

![img.png](images/find-command/multiplekeywords.png)

**Notes**:
* The `find` command queries the original unfiltered list of persons, meaning that `find` commands cannot be stacked.

### Filtering persons by status:

What if you have no information about an applicant or interviewer's name, phone or email though? Fret not, for the `filter_by_status` command enables you to narrow down the current list of persons on the basis of their current status.
Expand Down
Loading