forked from nus-cs2103-AY2324S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
21 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,7 +35,7 @@ HouR is a **desktop app for managing employee records, optimized for use via a C | |
| - [Adding a leave period](#adding-a-leave-period-of-an-employee-addleave): `addleave` | ||
| - [Deleting a leave period](#deleting-a-leave-period-of-an-employee-deleteleave): `deleteleave` | ||
| - [Editing a leave date](#editing-a-leave-date-of-an-employee--editleave): `editleave` | ||
| - [Listing employees on leave](#listing-the-employees-on-leave-on-a-specified-date--listleave) `listleave` | ||
| - [Listing employees on leave](#listing-the-employees-on-leave-on-a-specified-date--listleave): `listleave` | ||
| - [Adding remarks](#adding-a-remark-for-an-employee--addremark): `addremark` | ||
| - [Deleting remarks](#deleting-a-remark-of-an-employee--deleteremark): `deleteremark` | ||
| - [Updating overtime hours](#updating-overtime-hours-of-an-employee--overtime): `overtime` | ||
|
|
@@ -92,8 +92,8 @@ The following glossary table provides clarification on commonly-used terms as we | |
| A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br> | ||
|  | ||
|
|
||
| <div markdown="span" class="alert alert-warning">:exclamation: **Caution to Mac users:** | ||
| Performing these instructions may result in non-deterministic behaviour of data loading in HouR. This was tested on multiple MacOS Systems: | ||
| <div markdown="span" class="alert alert-warning">:exclamation: **Caution to macOS users:** | ||
| Performing these instructions may result in non-deterministic behaviour of data loading in HouR. This was tested on multiple macOS Systems: | ||
| <br/>1. Right-click `hour.jar` > Open With > JavaLauncher.app | ||
| <br/>2. First-time users may be prompted with a warning that the file was downloaded from the Internet. Simply click Open in the prompt to continue. | ||
|
|
||
|
|
@@ -102,37 +102,37 @@ Performing these instructions may result in non-deterministic behaviour of data | |
| 5. Type a command in the command box and press Enter to execute it. e.g. typing `help` and pressing Enter will open the help window.<br> | ||
| Some example commands you can try: | ||
|
|
||
| * `help`: Shows help window with link to user guide. | ||
| * `help` : Shows help window with link to user guide. | ||
|
|
||
| * `add n/John Doe pos/Senior Software Enginner id/EID2023-7890 p/81239876 e/[email protected] s/5000` : Adds an employee named `John Doe` to the employee list. | ||
|
|
||
| * `list` : Lists all employees. | ||
|
|
||
| * `edit 1 n/Alex Yeoh`: Edits the name of the 1st employee shown in the current list to `Alex Yeoh`. | ||
| * `edit 1 n/Alex Yeoh` : Edits the name of the 1st employee shown in the current list to `Alex Yeoh`. | ||
|
|
||
| * `find Alex Manager`: Lists all employees with the keywords `Alex` or `Manager`. | ||
|
|
||
| * `delete EID2023-1234` : Deletes the employee with employee id EID2023-1234 shown in the list. | ||
|
|
||
| * `sort f/salary in/asc`: Sorts the employees by their salaries in ascending order. | ||
| * `sort f/salary in/asc` : Sorts the employees by their salaries in ascending order. | ||
|
|
||
| * `addleave id/EID1234-5678 from/2023-12-26 to/2023-12-28`: Adds leave dates from 26 to 28 December 2023 inclusive for employee with id EID1234-5678. | ||
| * `addleave id/EID1234-5678 from/2023-12-26 to/2023-12-28` : Adds leave dates from 26 to 28 December 2023 inclusive for employee with id EID1234-5678. | ||
|
|
||
| * `deleteleave id/EID1234-5678 from/2023-12-27 to/2023-12-27`: Deletes leave date 27 December 2023 for employee with id EID1234-5678. | ||
| * `deleteleave id/EID1234-5678 from/2023-12-27 to/2023-12-27` : Deletes leave date 27 December 2023 for employee with id EID1234-5678. | ||
|
|
||
| * `editleave id/EID1234-5678 old/2023-12-26 new/2023-12-29`: Edits the old leave date on 26 December 2023 of employee with id EID1234-5678 to new leave date on 29 December 2023. | ||
| * `editleave id/EID1234-5678 old/2023-12-26 new/2023-12-29` : Edits the old leave date on 26 December 2023 of employee with id EID1234-5678 to new leave date on 29 December 2023. | ||
|
|
||
| * `listleave on/2023-12-28`: Lists all employees on leave on 28 December 2023. | ||
| * `listleave on/2023-12-28` : Lists all employees on leave on 28 December 2023. | ||
|
|
||
| * `addremark id/EID1234-5678 r/good worker`: Adds the remark `good worker` to the employee with id EID1234-6788. | ||
| * `addremark id/EID1234-5678 r/good worker` : Adds the remark `good worker` to the employee with id EID1234-6788. | ||
|
|
||
| * `deleteremark id/EID1234-5678 r/good worker`: Deletes the remark `good worker` from the employee with id EID1234-5678. | ||
| * `deleteremark id/EID1234-5678 r/good worker` : Deletes the remark `good worker` from the employee with id EID1234-5678. | ||
|
|
||
| * `overtime id/EID1234-5678 o/inc a/10`: Increases the overtime hours of employee with id EID1234-5678 by 10 hours. | ||
| * `overtime id/EID1234-5678 o/inc a/10` : Increases the overtime hours of employee with id EID1234-5678 by 10 hours. | ||
|
|
||
| * `report EID1234-5678`: Generates a report with details of the employee with id EID1234-5678. | ||
| * `report EID1234-5678` : Generates a report with details of the employee with id EID1234-5678. | ||
|
|
||
| * `reset f/overtime`: Resets the overtime hours field of all employees to the default value 0. | ||
| * `reset f/overtime` : Resets the overtime hours field of all employees to the default value 0. | ||
|
|
||
| * `clear` : Deletes all employees. | ||
|
|
||
|
|
@@ -255,7 +255,7 @@ Format: `exit` | |
|
|
||
| This section contains commands relating to the employee list and/or employees. | ||
|
|
||
| ### Adding an employee: `add` | ||
| ### Adding an employee : `add` | ||
|
|
||
| Adds an employee to the employee list. | ||
|
|
||
|
|
@@ -369,7 +369,7 @@ Examples: | |
|
|
||
| You can use the following commands to keep track of employee metrics and gauge employee performance. | ||
|
|
||
| ### Adding a leave period of an employee: `addleave` | ||
| ### Adding a leave period of an employee : `addleave` | ||
|
|
||
| Adds the dates between a specified period of time to the leaves taken by the specified employee. | ||
|
|
||
|
|
@@ -404,7 +404,7 @@ Examples: | |
|
|
||
|  | ||
|
|
||
| ### Deleting a leave period of an employee: `deleteleave` | ||
| ### Deleting a leave period of an employee : `deleteleave` | ||
|
|
||
| Deletes the specified leave dates of an employee. | ||
|
|
||
|
|
@@ -656,10 +656,10 @@ DO NOT modify data directly as it might result in the malfunction of the applica | |
| **Method 2**: For users that wish to create a script to launch HouR (Recommended) | ||
| 1. Create a new text file | ||
| 2. Copy and paste the following into the text file: `java -jar [JAR file location]/hour.jar` | ||
| 3. Save the text file as `hour.bat` (Windows) or `hour.sh` (MacOS/Linux) | ||
| 3. Save the text file as `hour.bat` (Windows) or `hour.sh` (macOS/Linux) | ||
| 4. Change the admin settings of the script to allow it to run as program: | ||
| * Windows: Right-click on the script and select **Properties**. Under **General**, check the box that says `Allow this file to run as a program`. | ||
| * MacOS/Linux: Open the Terminal and navigate to the directory where the script is located. Type `chmod +x [script name]` and press Enter.<br> | ||
| * macOS/Linux: Open the Terminal and navigate to the directory where the script is located. Type `chmod +x [script name]` and press Enter.<br> | ||
| Note: (`chmod +x` changes permissions of the script to allow it to be executed) | ||
| 5. Double-click on the script to launch HouR | ||
| 6. HouR should launch | ||
|
|
@@ -671,7 +671,7 @@ If you have any further issues, please raise an issue on our [Github page](https | |
| **Q**: How can I check my Java version?<br> | ||
| **A**: Open a Command Prompt and type `java -version`. If you do not have Java installed, you can install Java 11 using the Oracle guide [here](https://www.oracle.com/java/technologies/downloads/#java11). Alternatively, you can install the OpenJDK version. | ||
|
|
||
| For Mac users, you may wish to follow the instructions listed [here](https://nus-cs2103-ay2324s1.github.io/website/admin/programmingLanguages.html). | ||
| For macOS users, you may wish to follow the instructions listed [here](https://nus-cs2103-ay2324s1.github.io/website/admin/programmingLanguages.html). | ||
|
|
||
| ### Loading Data from Another Computer | ||
|
|
||
|
|
||