Skip to content

Commit

Permalink
Merge pull request #161 from cheahTJ/documentation
Browse files Browse the repository at this point in the history
Edit more UG and DG and add AronaPro UI image
  • Loading branch information
hjuntan authored Apr 4, 2024
2 parents 2e17bec + 94d7683 commit 2ee9664
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 11 deletions.
7 changes: 4 additions & 3 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -714,7 +714,8 @@ testers are expected to do more *exploratory* testing.

1. Download the jar file and copy into an empty folder

1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.
1. cd into that folder and execute the command `java -jar AronaPro.jar`
2. Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.

1. Saving window preferences

Expand All @@ -725,9 +726,9 @@ testers are expected to do more *exploratory* testing.

1. _{ more test cases …​ }_

### Deleting a person
### Example: Deleting a person

1. Deleting a person while all persons are being shown
1. Deleting a person with a specified `while all persons are being shown

1. Prerequisites: List all persons using the `list` command. Multiple persons in the list.

Expand Down
7 changes: 3 additions & 4 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Our product ensures that you can always centralise their contacts, connect and c
1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.

1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar aronapro.jar` command to run the application.<br>
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
A GUI similar to the below should appear in a few seconds.<br>
![Ui](images/Ui.png)

1. 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>
Expand Down Expand Up @@ -201,14 +201,13 @@ Format: `group [id/NUSID] [g/GROUP] [t/TAG]`
> * At least one of the optional fields must be provided.
> * When editing tags, the valid forms have to be either 1 of these: Professor, TA, Student, None
Examples:
* `group id/E0123456 g/CS2101`
> This command will assign or change a group of the person with `NUSID` E0123456 to 'CS2101'.
>
> ![assign-group](images/group/assign-group.png)
* `group id/E0123456 t/TA`
> This command will assign or change the tag of the person with `NUSID` E0123456 to 'TA'.
> ![assign-tag](images/group/assign-tag.png)
> This command will assign or change the tag of the person with `NUSID` E0123456 to 'TA'.
> ![assign-tag](images/group/assign-tag.png)

### Schedule a meeting with a person: `schedule`
Expand Down
Binary file modified docs/images/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 6 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,19 @@
title: ""
---

# AddressBook Level-3
# AronaPro

[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3)

![Ui](images/Ui.png)

**AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
AronaPro is a **desktop app** catered primarily for Computing Professors and Teaching Assistants(TAs) to manage your students/professors/TAs contacts efficiently, optimised for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI).
Our product ensures that you can always centralise their contacts, connect and coordinate with them.

* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.

* If you are interested in using AronaPro, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
* If you are interested about developing AronaPro, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.


**Acknowledgements**
Expand Down

0 comments on commit 2ee9664

Please sign in to comment.