diff --git a/README.md b/README.md index de380de4bfa..536187a421b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ [![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-F12-3/tp/actions) - +[![codecov](https://codecov.io/gh/AY2324S2-CS2103T-F12-3/tp/graph/badge.svg?token=6NOAZHAJVS)](https://codecov.io/gh/AY2324S2-CS2103T-F12-3/tp) -![MockUi](docs/images/mockUI.png) +![Ui](docs/images/Ui.png) * This is **a CS2103T project by NUS Computing students**.
Example usages: diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b26724ef74a..02d52d73fb9 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -28,14 +28,16 @@ Hi Tutors! A warm welcome to our user guide, your companion for navigating and f ## [Quick start](#table-of-contents) -1. Ensure you have Java `11` or above installed in your Computer. +1. Ensure you have Java `11` or above installed in your Computer.
1. Download the latest `tutorpro.jar` from [here](https://github.com/AY2324S2-CS2103T-F12-3/tp/releases). 1. Copy the file to the folder you want to use as the _home folder_ for your TutorPro. 1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar tutorpro.jar` command to run the application.
- A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
+ + +3. A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
![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.
diff --git a/docs/images/java11.png b/docs/images/java11.png new file mode 100644 index 00000000000..a1120f72706 Binary files /dev/null and b/docs/images/java11.png differ diff --git a/docs/images/runJarFile.png b/docs/images/runJarFile.png new file mode 100644 index 00000000000..d14240ed870 Binary files /dev/null and b/docs/images/runJarFile.png differ