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

Added guide for available and meetings commands #68

Merged
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
56 changes: 45 additions & 11 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,22 +150,54 @@ You are now logged in successfully as Sebastian!
## 5. Employee Features

### 5.1 Declaring available timings for meetings: `available`
- For easier scheduling of meetings, cOOPer has a function to gather availabilities of everybody to find a common time for a meeting.
- How to input your availability:
1. After [logging in](#3-login) to the system, enter `available [username] at [time]`.
2. You will now have your name stored under the specified time in the system.

### 5.2 Viewing meetings: `meetings`
{Give detailed description of each feature}
> #### 📝Note:
> - `[username]` is the name you wish to enter the availability for. It is preferably your own username.
> - `[time]` has a format of **HH:mm**, in *24-hour clock*. Any other format will **not** be accepted and your availability will not be stored.
> - Duplicate `[username]` in one timeslot will **not** be accepted.

Adds a new item to the list of todo items.
- Expected input:

Format: `todo n/TODO_NAME d/DEADLINE`
```
>> available Sebastian at 14:00
```

* The `DEADLINE` can be in a natural language format.
* The `TODO_NAME` cannot contain punctuation.
- Expected output:

Example of usage:
```
=========================================================================
Success!
Sebastian's availability has been added to 14:00
=========================================================================
```

`todo n/Write the rest of the User Guide d/next week`
### 5.2 Viewing meetings: `meetings`
- To view the table of availabilities after inputting [availabilities](#51-declaring-available-timings-for-meetings-available), cOOPer allows you to visualise the availabilities in a table format.
- How to view available timings:
1. After [logging in](#3-login) to the system, enter `meetings`.
2. You will now obtain a table with the availabilities entered.

`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
- Expected input:

```
>> meetings
```

- Expected output:

```
=========================================================================
These are the availabilities:
┌────────────────────────────────────────────────────────────────────┐
│ 10:00 │ Eugene
│ 14:00 │ Sebastian
└────────────────────────────────────────────────────────────────────┘
=========================================================================
```

## 6. Exiting the program
Exits the program.
Expand All @@ -191,6 +223,8 @@ Bye, see you next time! :D

## 8. Command Summary

**Command** | **Format** | **Example**
------------|------------|------------
**Command** | **Format** | **Example**
------------|--------------------------------|------------
available |`available [username] at [time]`|`available Sebastian at 10:00`
meetings |`meetings` |`meetings`