forked from nus-cs2103-AY2324S2/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
1 parent
07dbd25
commit 3641ef2
Showing
1 changed file
with
17 additions
and
17 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 |
---|---|---|
|
@@ -3,20 +3,20 @@ layout: page | |
title: User Guide | ||
--- | ||
|
||
AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps. | ||
TeachStack is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, TeachStack can get your contact management tasks done faster than traditional GUI apps. | ||
|
||
* Table of Contents | ||
{:toc} | ||
{:toc} | ||
|
||
-------------------------------------------------------------------------------------------------------------------- | ||
|
||
## Quick start | ||
|
||
1. Ensure you have Java `11` or above installed in your Computer. | ||
|
||
1. Download the latest `TeachStack.jar` from [here](https://github.com/se-edu/addressbook-level3/releases). | ||
1. Download the latest `TeachStack.jar` from [here](https://github.com/AY2324S2-CS2103T-T09-1/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 TeachStack. | ||
|
||
1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar TeachStack.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> | ||
|
@@ -25,16 +25,16 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo | |
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 contacts. | ||
|
||
|
||
* `add id/A01234567H n/John Doe e/[email protected]` : Adds a student named `John Doe` to the list. | ||
* `add id/A01234567H n/John Doe e/[email protected]` : Adds a student named `John Doe` to the list. | ||
|
||
* `delete A0123456X` : Deletes the student with student id A0123456X from the list. | ||
* `delete A0123456X` : Deletes the student with student id A0123456X from the list. | ||
|
||
* `clear` : Deletes all students. | ||
* `clear` : Deletes all students. | ||
|
||
* `exit` : Exits the app. | ||
* `exit` : Exits the app. | ||
|
||
1. Refer to the [Features](#features) below for details of each command. | ||
|
||
|
@@ -71,7 +71,7 @@ Format: `help` | |
|
||
### Adding a person: `add` | ||
|
||
Adds student details to the address book. | ||
Adds student details to the list of students. | ||
|
||
Format: `add id/STUDENT_ID n/NAME e/EMAIL g/GRADE [t/TAG]` | ||
|
||
|
@@ -87,7 +87,7 @@ Examples: | |
|
||
### Editing a person : `edit` | ||
|
||
Edits an existing person in the address book. | ||
Edits an existing person in the list of students. | ||
|
||
Format: `edit [id/STUDENT_ID] [e/EMAIL] ` | ||
|
||
|
@@ -132,7 +132,7 @@ Examples: | |
|
||
### Clearing all entries : `clear` | ||
|
||
Clears all entries from the address book. | ||
Clears all entries from the list of students. | ||
|
||
Format: `clear` | ||
|
||
|
@@ -144,15 +144,15 @@ Format: `exit` | |
|
||
### Saving the data | ||
|
||
AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. | ||
TeachStack data is saved in the hard disk automatically after any command that changes the data. There is no need to save manually. | ||
|
||
### Editing the data file | ||
|
||
AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. | ||
TeachStack data is saved automatically as a JSON file `[JAR file location]/data/teachstack.json`. Advanced users are welcome to update data directly by editing that data file. | ||
|
||
<div markdown="span" class="alert alert-warning">:exclamation: **Caution:** | ||
If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.<br> | ||
Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. | ||
If your changes to the data file makes its format invalid, TeachStack will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.<br> | ||
Furthermore, certain edits can cause the TeachStack to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. | ||
</div> | ||
|
||
### Archiving data files `[coming in v2.0]` | ||
|
@@ -164,7 +164,7 @@ _Details coming soon ..._ | |
## FAQ | ||
|
||
**Q**: How do I transfer my data to another Computer?<br> | ||
**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder. | ||
**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous TeachStack home folder. | ||
|
||
-------------------------------------------------------------------------------------------------------------------- | ||
|
||
|