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.

Sign up for GitHub

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

Fix spacing in quickstart #340

Merged
merged 1 commit into from
Apr 15, 2024
Merged

Fix spacing in quickstart #340

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ Tailored for fast typists, MyBookshelf can get your contact and borrowing manage
- You can refer to this [YouTube video](https://www.youtube.com/watch?v=3nOmkqO0-SM) to check your current Java version.
- If you do not have `Java 11`, you are recommended to download it from [here](https://www.oracle.com/java/technologies/javase/jdk11-archive-downloads.html)
<br>

<br>
2. Download the latest `mybookshelf.jar` from [here](https://github.com/AY2324S2-CS2103T-F11-2/tp/releases).

3. Copy and paste the file to you will use as the _home folder_ for the *MyBookshelf* app.
- Open your _file explorer_ with Windows Key + E or clicking the _file explorer_ icon.
- Navigate to the _Downloads_ folder (Default directory for downloaded files will be the _Downloads_ folder).
- Copy the downloaded `mybookshelf.jar` and paste it to the folder you will use as the _home folder_ for the *MyBookshelf* app.
<br>

<br>
4. Access the command prompt.
- Open the Run menu with Windows Key + R, then type "cmd".<br>
![windows run with CMD](images/QuickStart/Windows/WindowsRtypeCMD.png)<br>
Expand All @@ -43,7 +43,7 @@ Tailored for fast typists, MyBookshelf can get your contact and borrowing manage
![command prompt](images/QuickStart/Windows/CommandPrompt.png)<br>
- If you have issues opening command prompt, you can refer this [YouTube video](https://www.youtube.com/watch?v=pBheH2QtktI&t=92s).
<br>

<br>
5. `cd` into the folder you placed `mybookshelf.jar` file in, and enter the following command to run the application.<br>
```
java -jar mybookshelf.jar
Expand Down Expand Up @@ -76,6 +76,7 @@ Tailored for fast typists, MyBookshelf can get your contact and borrowing manage
- Navigate to the _Downloads_ folder (Default directory for downloaded files will be the _Downloads_ folder).
- Copy the downloaded `mybookshelf.jar` and paste it to the folder you will use as the _home folder_ for the *MyBookshelf* app.
<br>
<br>
4. Access the terminal.
- Open the Spotlight search window using Command + Space, then type "Terminal".
- Double-click on Terminal in search result.<br>
Expand All @@ -84,7 +85,7 @@ Tailored for fast typists, MyBookshelf can get your contact and borrowing manage
![terminal](images/QuickStart/MacOS/terminal.png)<br>
- If you have issues opening Terminal window, you can refer [here](https://discussions.apple.com/thread/366608?sortBy=best)
<br>

<br>
5. `cd` into the folder you placed `mybookshelf.jar` file in, and enter the following command to run the application.<br>
```
java -jar mybookshelf.jar
Expand All @@ -96,7 +97,7 @@ Tailored for fast typists, MyBookshelf can get your contact and borrowing manage

6. A window similar to the one below should appear in a few seconds. Notice that the app initialises with some sample data.<br>

![macos default Ui](images/QuickStart/MacOS/default.png)
![macos default Ui](images/QuickStart/MacOS/default.png)<br>

7. Type the command into the command box and press Enter to execute it. E.g. typing [**`help`**](#viewing-help--help) and pressing Enter will open the help window.<br>

Expand Down
Loading