Mismatch between launch instructions for UG and DG

[juliantayyc]

In the UG, the following instructions are given for users to launch the application:

Note the use of the java -jar command in the terminal to launch.

However, in the DG, developers are asked to double-click the jar file (as shown):

The development team does not provide any explanation for why there are different launch instructions for users vs developers. Additionally, when attempting to follow the DG instructions, the following pop-up is shown (MacOS):

The developer guide does not provide any suggestions to get around this issue.

[soc-pe-bot]

Team's Response

Refer to comment in issue #2916

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Cannot double-click to open the jar file

In multiple places, the DG implies that the application can be opened by double-clicking the jar file (one example below).

However, this is not true and is quite misleading to any potential testers of the application.

Steps to reproduce

1. Open up the folder where the jar file is located
2. Double-click the jar file

Expected: Application opens up

Actual: Error message shows up OR nothing happens (more common).

OS: MacOS Sequoia 15.0.1
Java version (copied from terminal):

openjdk 17.0.11 2024-04-16 LTS
OpenJDK Runtime Environment Zulu17.50+19-CA (build 17.0.11+9-LTS)
OpenJDK 64-Bit Server VM Zulu17.50+19-CA (build 17.0.11+9-LTS, mixed mode, sharing)

---

_{[original: nus-cs2103-AY2425S1/pe-interim#3980] [original labels: type.DocumentationBug severity.High]}

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

It's possible for one to open the application via double click depending on the user's settings. However, the instruction of the module which specifically states that you should use the java -jar command to launch the app. This should at most be a documentation bug of low severity as we did not match the instruction to launch an app with the module's instruction. This will likely only cause inconvenience to individuals who didn't adhere to the module instruction, using the Mac OS and does not have the correct privacy settings, which we believe is a extremely small group of people.

We have also tried it on windows machines and it works properly for machines that has java correctly installed.

video:https://raw.githubusercontent.com/nus-cs2103-AY2425S1/pe/master/files/462f8cf3-f4f5-4f83-9833-9f61a5c63e5e.mov

Items for the Tester to Verify

❓ Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

• I disagree

Reason for disagreement: [replace this with your explanation]

---

❓ Issue type

Team chose [type.FeatureFlaw]
Originally [type.DocumentationBug]

• I disagree

Reason for disagreement: As the team has stated, this is a documentation bug of low severity, not feature flaw. This aligns with my initial bug type assignment.

---