Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
gyulong1 committed Apr 14, 2023
2 parents 6c84dee + 75ae1c6 commit 79c6f32
Show file tree
Hide file tree
Showing 7 changed files with 62 additions and 34 deletions.
96 changes: 62 additions & 34 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,16 @@ title: ExecutivePro User Guide
<a id="top"></a>

## Introduction
Welcome to ExecutivePro, an all-in-one solution for managing employees' information.
Are you tired of grappling with time-consuming tasks? Do you want to streamline your HR processes and boost your productivity?

Welcome to **ExecutivePro, an all-in-one Human Resource (HR) solution for managing employee information**.
Are you a growing startup looking for its first HR software?
Are you tired of grappling with time-consuming tasks?
Do you want to streamline your HR processes and boost your productivity?
Look no further! ExecutivePro is here to make it happen.

ExecutivePro is a **desktop app specifically designed for Human Resource managers to manage their employee information,
optimized for use via an easy-to-use Command Line Interface (CLI)** while still retaining the benefits of a
Graphical User Interface (GUI). With ExecutivePro, you can streamline your HR processes and free yourself from the drudgery of mundane tasks.
ExecutivePro is a **desktop app for HR managers** that you can use to **keep track of your employees' personal information, filter through employee data, manage their leaves, and more!**
ExecutivePro features an easy-to-use Command Line Interface (CLI), which means it's designed to save you time by letting you do everything from **just your keyboard**.
With ExecutivePro, you can optimise your HR workflow and free yourself from the drudgery of mundane tasks.

The purpose of this guide is to walk you through the comprehensive features of ExecutivePro and to help you troubleshoot any problems you may face while using ExecutivePro.
Read on to learn more and experience the game-changing benefits that ExecutivePro can bring to your work!
Expand Down Expand Up @@ -64,25 +67,23 @@ Follow these steps if this is your first time using ExecutivePro:
- If you are using an Apple Silicon Mac, you can install the Azul build of OpenJDK 11 version
from [here](https://www.azul.com/downloads/?version=java-11-lts&os=macos&architecture=arm-64-bit&package=jdk-fx).
2. Download the latest `ExecutivePro.jar` from [here](https://github.com/AY2223S2-CS2103T-W09-4/tp/releases).

3. Copy the jar file to a folder you want to use as the _main folder_ for your ExecutivePro.
This folder can be on your Desktop or any location you prefer.
For example, we create a `test` folder on the Desktop.
<p align="center">
<img src="images/jarfile.png" width="75%" height="50%">
<br>
<em>`test` folder</em>
</p>

Next, we place the `ExecutivePro.jar` file in the `test` folder as shown below.
<p align="center">
<img src="images/jarfile2.png" width="75%" height="50%">
<br>
<em>ExecutivePro jar file</em>
</p>
<p align="center">
<img src="images/jarfile.png" width="100%" height="50%">
<br>
<em>`test` folder</em>
</p>

Next, we place the `ExecutivePro.jar` file in the `test` folder as shown below.
<p align="center">
<img src="images/jarfile2.png" width="100%" height="50%">
<br>
<em>ExecutivePro jar file</em>
</p>

4. Now you are ready to use ExecutivePro, refer to the section [Starting ExecutivePro](#starting-executivepro) below for more details.

<div markdown="block" class="alert alert-info">

### Starting ExecutivePro
Expand Down Expand Up @@ -121,7 +122,7 @@ A window like below should appear in seconds.
Note how the app contains some sample data.

<p align="center">
<img src="images/quickstartui.png" width="50%" height="50%">
<img src="images/quickstartui.png" width="75%" height="50%">
<br>
<em>Starting Page</em>
</p>
Expand All @@ -140,7 +141,7 @@ Congratulations, ExecutivePro is now running, you can refer to the [Features](#f
Below is the ExecutivePro User Interface with the main components labelled.

<p align="center">
<img src="images/labelledgui.png" width="70%" height="50%">
<img src="images/labelledgui.png" width="75%" height="50%">
<br>
<em>User Interface</em>
</p>
Expand Down Expand Up @@ -173,7 +174,7 @@ This toolbar can be used to:
#### 2. Display Panel

<p align="center">
<img src="images/displaypanel.png" width="50%" height="50%">
<img src="images/displaypanel.png" width="75%" height="50%">
<br>
<em>Display Panel</em>
</p>
Expand All @@ -189,7 +190,7 @@ This section shows the full information of the selected employee.
#### 3. Employee List

<p align="center">
<img src="images/employeelist.png" width="50%" height="50%">
<img src="images/employeelist.png" width="75%" height="50%">
<br>
<em>Employee List</em>
</p>
Expand All @@ -204,7 +205,7 @@ This will come in handy if:
#### 4. Command Panel

<p align="center">
<img src="images/commandpanel.png" width="50%" height="50%">
<img src="images/commandpanel.png" width="100%" height="50%">
<br>
<em>Command Panel</em>
</p>
Expand All @@ -213,7 +214,12 @@ This section displays relevant messages or errors after the command is entered.

#### 5. Command Line Interface (CLI)

<img src="images/UserGuide/CLI.png" class="centerImage">
<p align="center">
<img src="images/CLI.png" width="100%" height="50%">
<br>
<em>Command Line Interface(CLI)</em>
</p>

In this section, you can enter your command in the text box and click enter on your keyboard to send it to the application.

This is also known as a Command Line Interface or CLI for short. If you are new to CLI, a crash course is available below.
Expand Down Expand Up @@ -285,7 +291,7 @@ We know that there can be a lot of information to take in for a new user, so if
Entering the `help` command will open up the _Help Window_ that looks like this.

<p align="center">
<img src="images/helpwindow.png" width="50%" height="50%">
<img src="images/helpwindow.png" width="100%" height="50%">
<br>
<em>Help Window</em>
</p>
Expand Down Expand Up @@ -413,23 +419,45 @@ ExecutivePro expects dates to be in the following format: YYYY-MM-DD. If the dat
Follow the steps below to ensure the dates in Excel are following the correct format:

1. Firstly, you can select the two columns involving dates, `Date of Birth` and `Date of Joining`, just like the image below.
![](images/UserGuide/batchadd/selectingcolumns.png)

<p align="center">
<img src="images/selectingcolumns.png" width="80%" height="80%">
<br>
<em>Selecting date columns in Excel file</em>
</p>
2. Next, right-click on the selected columns so that the following shows up:

<img class="centerImage" src="images/UserGuide/batchadd/rightclick.png" width=250>
<p align="center">
<img src="images/rightclick.png" width="80%" height="80%">
<br>
<em>Right click to format selected cells</em>
</p>

3. Click on `Format Cells...` and the table below will appear:
![](images/UserGuide/batchadd/formattable.png)
<p align="center">
<img src="images/format.png" width="80%" height="80%">
<br>
<em>Format cells table</em>
</p>

4. Click on `Date`:
![](images/UserGuide/batchadd/formattabledate.png)
<p align="center">
<img src="images/formatdate.png" width="80%" height="80%">
<br>
<em>Clicking on date</em>
</p>

5. Select the correct date format ("YYYY-MM-DD"):
![](images/UserGuide/batchadd/correctformattable.png)
<p align="center">
<img src="images/correct.png" width="80%" height="80%">
<br>
<em>Correct date format</em>
</p>

6. Click `OK` and the date in the file will be updated to the correct format:
![](images/UserGuide/batchadd/successCSV.png)
<p align="center">
<img src="images/successCSV.png" width="80%" height="80%">
<br>
<em>Correct date format in Excel file</em>
</p>


Once the dates in your CSV file are in the correct format (YYYY-MM-DD),
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes

0 comments on commit 79c6f32

Please sign in to comment.