Skip to content

Commit

Permalink
Merge pull request #333 from choaticman/branch-dylan-v1.6
Browse files Browse the repository at this point in the history
Fix more broken links
  • Loading branch information
Raghava-Chittidi authored Nov 11, 2024
2 parents 2c4c280 + 38cbb71 commit 2a57188
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ HireMe is a **free desktop application that helps you manage your extensive list
<br></br>
### Table of Contents
<!-- TOC -->
* [![icon](images/hireme_logo.png) HireMe User Guide](#-hireme-user-guide)
* [Welcome to HireMe!](#welcome-to-hireme)
* [Overview of User Guide](#overview-of-user-guide)
* [Overview of target users](#overview-of-target-users)
Expand Down Expand Up @@ -111,53 +110,52 @@ This section has two parts: complete [Part 1](#part-1-setting-up-and-downloading
3. Create a new folder and name it any name you want (e.g. HireMe).


4. Find the downloaded `hireme.jar` file and drag it into the folder you created in step 3.
4. Find the downloaded `hireme.jar` file and drag it into the folder you created in step 3. <br>
![hiremejar](images/HireMeJar.png)

<br></br>
### Part 2: Using the HireMe application

For steps 5 and 6, refer to **either** [Mac Users](#mac-users) **or** [Windows Users](#windows-users) section that matches your computer system.
Continue to [Using the terminal](#using-the-terminal) after completing steps 5 and 6.
<br></br>
#### _Mac users_
5. Use mac spotlight search (Command + Space bar) and type Terminal, click on open.

<img src="images/MacTerminal.png" alt="macsterminal" width="750"/>
<br></br>
You will see a window like this.
<img src="images/MacTerminal.png" alt="macsterminal" width="810"/>

You will see a window like this. <br>

![openmacterminal](images/OpenMacTerminal.png)


6. Click into the folder created in step 3. Left click on the `hireme.jar` file and select `Get Info`.
6. Click into the folder created in step 3. Left click on the `hireme.jar` file and select `Get Info`. <br>
![macfilepathinfo](images/Macfilepathinfo.png)
<br></br>
On the new open that pops up, left click on `Where` and copy the file path.

<img src="images/Macfilepath.png" alt="macfilepath" width="300"/>
<img src="images/Macfilepath.png" alt="macfilepath" width="810"/>
<br></br>

#### _Windows users_
5. Use windows search and type Terminal, click on open.
![windowsterminal](images/WindowsTerminal.png)
<br></br>
You will see a window like this.
You will see a window like this. <br>
![openwindows](images/OpenWindowsTerminal.png)


6. Click into the folder created in step 3. Click on the empty space of the bar located at the top and copy the file path.
6. Click into the folder created in step 3. Click on the empty space of the bar located at the top and copy the file path.<br>
![windowsfilepath](images/Windowsfilepath.png)
<box type="info" seamless>
<strong>Note:</strong> File path here is highlighted in blue
</box>
<br></br>

#### _Using the terminal_
7. Type `cd FILEPATH` (replacing FILEPATH with the actual file path copied in step 6) and press enter.
7. Type `cd FILEPATH` (replacing FILEPATH with the actual file path copied in step 6) and press `Enter`.


8. Type `java -jar hireme.jar` and press enter to run the HireMe application.
8. Type `java -jar hireme.jar` and press `Enter` to run the HireMe application.
<br></br>
- Windows Terminal:
![windowscd](images/Windowscd.png)
Expand All @@ -172,7 +170,7 @@ A GUI similar to the below should appear in a few seconds. It is encouraged to *

![Ui](images/LabelledUi.png)

9. Type the command in the command box and press Enter to execute it. (e.g. typing **`/help`** and pressing Enter will open the help window.)<br></br>
9. Type the command in the command box and press `Enter` to execute it. (e.g. typing **`/help`** and pressing `Enter` will open the help window.)<br></br>
Some example commands you can try:

* `/add n/Google r/Software Engineer Intern e/google@gmail.com d/16/09/24`: Adds an internship application at Google to the list of added entries.
Expand Down Expand Up @@ -267,12 +265,12 @@ Format: `/delete INDEX`
* Deletes the internship application at the specified `INDEX`.
* The `INDEX` refers to the index number shown in the displayed internship application list.
* The `INDEX` **must be a positive integer** 1, 2, 3, …​
* The `INDEX` **must be a valid index number** (e.g. 5 is not valid when there is less than 5 applications).
* The `INDEX` **must be a valid index number** (e.g. 5 is not valid when there is less than five applications).

Examples:
* `/list` followed by `/delete 2` deletes the 2nd application in the list.
* `/find Google` followed by `/delete 1` deletes the 1st application in the results of the `/find` command.
* `/list` followed by `/delete 4` when you only have 3 internship applications returns an error message.
* `/list` followed by `/delete 2` deletes the second application in the list.
* `/find Google` followed by `/delete 1` deletes the first application in the results of the `/find` command.
* `/list` followed by `/delete 4` when you only have three internship applications returns an error message.

<p>These are the before and after images of the first example</p>
<div style="display: flex;">
Expand All @@ -291,7 +289,7 @@ Format: `/find KEYWORD [ADDITIONAL_KEYWORDS]`
* The search is **case-insensitive**. e.g. `goo` will match `Google`.
* The search is **only for company names**.
* The search uses **prefix search**.
* The search allows for **more than 1 `KEYWORD`**
* The search allows for **more than one `KEYWORD`**
* If you search for `go`, then you will see a list of all the internship applications that you have applied for
whose companies have words starting with `go` in their names.

Expand Down Expand Up @@ -372,7 +370,7 @@ Sorts your internship applications in **ascending / descending** order based on

Format: `/sort ORDER`

* There are only 2 orders that are valid: `earliest` or `latest` only.
* There are only two orders that are valid: `earliest` or `latest` only.
* The order is case-insensitive. (e.g. `"earliest"`, `"eaRLiEsT"` and `"EARLIEST"` are all allowed.)
* Once you sort the list, even if you exit the application and reopen it, the list remains sorted unless you add more internship applications.
* Even if you find or filter the list, sorting it afterwards will also sort the entire main list.
Expand Down Expand Up @@ -509,7 +507,7 @@ Action | Format, Examples
- **Application Status**:
- **PENDING**: The internship application is currently in progress.
- **REJECTED**: The user has rejected or been rejected from this internship application.
- **ACCEPTED**: The user has accepted the offer for this internship.
- **ACCEPTED**: The user has accepted the offer for this internship.<br>

- **Action**: The task carried out by the HireMe application such as Add, Delete, Update entries.

Expand All @@ -528,3 +526,5 @@ Action | Format, Examples
- **Role**: The role of the internship the user applied for.

- **Index**: The index of the internship application displayed in the list.

- **Order**: The order that the user would like the list to be in, based on the date of application.

0 comments on commit 2a57188

Please sign in to comment.