Skip to content

Commit

Permalink
Merge pull request nus-cs2103-AY2324S1#4 from AY2324S1-CS2103T-F10-4/…
Browse files Browse the repository at this point in the history
…master

Fetch from team master
  • Loading branch information
jovkusuma committed Oct 6, 2023
2 parents 902bc7e + bcf8cf3 commit d22d45c
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 13 deletions.
8 changes: 5 additions & 3 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,15 +255,17 @@ _{Explain here how the data archiving feature will be implemented}_

### Product scope

**Target user profile**:
**Target user profile**: Private tutors not affiliated to any tuition organisations

* has a need to manage a significant number of contacts
* has a need to manage multiple tutees
* has a need for managing personal tutoring schedule
* prefer desktop apps over other types
* can type fast
* prefers typing to mouse interactions
* is reasonably comfortable using CLI apps

**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
**Value proposition**: It is tedious for tutors to keep track of multiple students and this is done conventionally through calendar applications. Simplify tutoring business with TuitionConnect. Effortlessly manage students, schedules and progress tracking while ensuring financial organization in an all in one product at a faster rate than non CLI applications.



### User stories
Expand Down
16 changes: 6 additions & 10 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,22 @@ Tuition connect is a desktop app that helps tutors keep track of their tutees an

1. Ensure you have Java `11` or above installed in your Computer.

1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases).
1. Download the latest `TuitionConnect.jar` from [here](https://github.com/AY2324S1-CS2103T-F10-4/tp/releases).

1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.
1. Copy the file to the folder you want to use as the _home folder_ for your TuitionConnect.

1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.<br>
1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar TuitionConnect.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>
![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>
Some example commands you can try:

* `list` : Lists all contacts.
* `list` : Lists all tutees.

* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book.
* `add n/John Doe p/98765432 a/John street, block 123, #01-01 sb/Primary 4 Math d/wed b/1500 e/1600` : Adds a tutee named `John Doe` to the list.

* `delete 3` : Deletes the 3rd contact shown in the current list.

* `clear` : Deletes all contacts.

* `exit` : Exits the app.
* `delete 3` : Deletes the 3rd tutee shown in the current list.

1. Refer to the [Features](#features) below for details of each command.

Expand Down
Binary file modified docs/images/jovkusuma.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d22d45c

Please sign in to comment.