Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add images in Quick Start #175

Merged
merged 7 commits into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 badge](https://codecov.io/gh/nus-cs2103-AY2324S2/tp/graph/badge.svg?token=PBBJNYE8U5)](https://codecov.io/gh/nus-cs2103-AY2324S2/tp)--->
[![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**.<br>
Example usages:
Expand Down
6 changes: 4 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br><img src="images/java11.png" width="550px">

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.<br>
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
<img src="images/runJarFile.png" width="450px">

3. 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>
Expand Down
Binary file added docs/images/java11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/runJarFile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading