Skip to content

Commit

Permalink
Merge pull request #97 from ldinghan/branch-update-ug
Browse files Browse the repository at this point in the history
Update UG docs
  • Loading branch information
ldinghan authored Oct 27, 2023
2 parents b66ee26 + eafbe64 commit a4997a2
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 16 deletions.
25 changes: 12 additions & 13 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The following describes what each panel contains:
3. Copy the file to the folder you want to use as the _home folder_ for your F.A.K.E.J.A.R.V.I.S..

4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar fakejarvis.jar` command to run the application.<br>
A GUI similar to the below should appear in a few seconds. (Currently, the image below is a mock-up of our GUI) Note how the app contains some sample data.<br>
A GUI similar to the image below should appear in a few seconds. (Currently, the image below is a mock-up of our GUI) Note how the app contains some sample data.<br>

![Ui](images/Ui.png)

Expand Down Expand Up @@ -326,24 +326,23 @@ Examples:
* `takeattendance n/John Doe s/5 present` Marks John Doe as present on the 5th session.
* `takeattendance n/Foo Bar s/2 absent` Marks Foo Bar as absent on the 2nd session.

### 👀Viewing attendance: viewattendance
### 👀Viewing attendance: `viewattendance`
Views the attendance list

Format: `viewattendance n/STUDENT_NAME s/SESSION`
Format: `viewattendance n/STUDENT_NAME [MORE_STUDENT_NAMES]`

Parameters:
* STUDENT_NAME - The name of the student.
* SESSION - The session number.
* STUDENT_NAME - The name of the student you want to view the attendance of.

Examples:
* `viewattendance` Displays the overall attendance across all students and sessions.
* `viewattendance n/Rayan` Displays Rayan’s overall attendance.
* `viewattendance s/3` Displays all students’ attendance for the 3rd session.
* `viewattendance n/Rayan` Displays all the sessions that Rayan has attended.
* `viewattendance n/Jayson Resley` Displays all the sessions that Jayson and Resley have attended.

### 🔎Finding a Student: find
### 🔎Finding a Student: `find`
Finds a student’s profile

Format: `find n/STUDENT_NAME`
Format: `find n/STUDENT_NAME [MORE_STUDENT_NAMES]`

Parameters:
* STUDENT_NAME - The name of the student you want to find.
Expand All @@ -352,7 +351,7 @@ Examples:
* `find n/John Doe` Finds and displays the profile of students with the name “John Doe”.
* `find n/Jane Doe` Finds and displays the profile of students with the name “Jane Doe”.

### 🥅Filtering results: filter
### 🥅Filtering results: `filter`
Filters the results displayed on the dashboard

Format:
Expand Down Expand Up @@ -506,7 +505,7 @@ Shows the list of upcoming consultations.

Format: `showconsults`

Examples:
Example:
* `showconsults` displays a list of upcoming consultations


Expand Down Expand Up @@ -543,7 +542,7 @@ Examples:
* `addtoconsult -1 n/Foo Bar`shows an error message.


### Remove students from a consultation: `removefromconsult`
### Removing students from a consultation: `removefromconsult`
Removes student(s) from a consultation.

Format: `removefromconsult INDEX n/STUDENT_NAME …`
Expand Down Expand Up @@ -574,7 +573,7 @@ Examples:

## FAQ

**Q**: How do I transfer my data to another Computer?<br>
**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 F.A.K.E.J.A.R.V.I.S. home folder.

--------------------------------------------------------------------------------------------------------------------
Expand Down
10 changes: 7 additions & 3 deletions docs/team/ldinghan.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,13 @@ F.A.K.E.J.A.R.V.I.S. is a project to help CS1101S Avengers manage their time and

Below are my contributions to the project:

* **New Features**: To be added
* **New Features**:
* Create session
* Add remarks to sessions
* Take attendance of students
* View attendance of students

* **Code contributed**: To be added
* **Code contributed**: [RepoSense](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=ldinghan&breakdown=true)

* **Project management**: To be added

Expand All @@ -26,7 +30,7 @@ Below are my contributions to the project:

* **Review/mentoring contributions**: To be added

* **Tools**: To be added
* **Tools**: Java, IntelliJ, FXML, PlantUML

* **Contributions beyond the project team**: To be added

0 comments on commit a4997a2

Please sign in to comment.