docs: Add -Ddebug.mode=true, improve README

README.md

@@ -6,12 +6,13 @@ Spark
 
   - Group Chat
   - In-line Spell Checking
-  - Strong Message Encryption
+  - End-to-end (E2E) Message Encryption with OTR.
   - Tabbed Conversations
   - File Transfer
   - Screen Capture Sharing
+  - Message translations.
 
-Combined with the [Openfire] server, [Spark] is the easiest and best alternative to using un-secure public IM networks.
+Combined with the [Openfire] server, [Spark] is the easiest and best alternative to using unsecure public IM networks.
 
 [Spark] - an [Ignite Realtime] community project.
 
@@ -30,12 +31,9 @@ Resources
 Install
 -------
 
-Download last release from [GitHub releases page](https://github.com/igniterealtime/Spark/releases/latest)
+Download the last release from the [GitHub releases page](https://github.com/igniterealtime/Spark/releases/latest)
-or [nightly build](https://igniterealtime.org/downloads/nightly_spark.jsp) with latest changes.
+or [nightly build](https://igniterealtime.org/downloads/nightly_spark.jsp) with the latest changes.
-For Windows, if you are not sure, if it's recommended to download the `spark_*-64bit.msi`.
+For Windows, if you are not sure, if it's recommended to download the ` spark_*-with-jre-amd64.exe` that has bundled JRE.
-If you don't have Java JRE installed then download and install an `.msi` file the of the JRE 17 or newer from 
-[Zulu](https://www.azul.com/downloads/?os=windows&architecture=x86-64-bit&package=jre#zulu)
-or [Oracle](https://www.oracle.com/java/technologies/downloads/#jdk25-windows).
 
 Screenshots
 ---------
@@ -63,16 +61,19 @@ Run from sources
 ----------------
 
 ```bash
-$ git clone https://github.com/igniterealtime/Spark.git
+git clone https://github.com/igniterealtime/Spark.git
-$ cd Spark/core
+mvn verify
-$ mvn exec:java
+cd Spark/core
+mvn exec:java
 ```
 
-* Setup IDE with the source:
+To run from an IDE execute the Main class `org.jivesoftware.Spark` and specify VM option `-Ddebug.mode=true`.
-    * [Intellij](https://download.igniterealtime.org/spark/docs/latest/documentation/ide-intellij-setup.html),
+
+* Set up IDE with the source:
+    * [IntelliJ](https://download.igniterealtime.org/spark/docs/latest/documentation/ide-intellij-setup.html),
     * [Eclipse](https://download.igniterealtime.org/spark/docs/latest/documentation/ide-eclipse-setup.html),
     * [Visual Studio Code](https://download.igniterealtime.org/spark/docs/latest/documentation/ide-vscode-setup.html).
-* [Plugins development guide](https://download.igniterealtime.org/sparkplug_kit/docs/latest/sparkplug_dev_guide.html)
+* [Plugin development guide](https://download.igniterealtime.org/sparkplug_kit/docs/latest/sparkplug_dev_guide.html)
 * [Spark Development Forum](https://discourse.igniterealtime.org/c/spark/spark-dev)
 
 

core/src/documentation/ide-eclipse-setup.html

@@ -98,17 +98,18 @@
         </p>
 
         <figure>
-            <a href="images/eclipse-maven-step-5.png"><img src="images/eclipse-maven-step-5.png" alt="Launch the 'Startup' class as a Java application."></a>
+            <a href="images/eclipse-maven-step-5.png"><img src="images/eclipse-maven-step-5.png" alt="Launch the 'Spark' class as a Java application."></a>
-            <a href="images/eclipse-maven-step-6.png"><img src="images/eclipse-maven-step-6.png" alt="The Spark login screen, after launching the 'Startup' class."></a>
+            <a href="images/eclipse-maven-step-6.png"><img src="images/eclipse-maven-step-6.png" alt="The Spark login screen, after launching the 'Spark' class."></a>
             <figcaption>Run Spark straight from the source code.</figcaption>
         </figure>
 
         <p>
             The 'spark-core' module contains a class named <code>org.jivesoftware.Spark</code>
             that can be used to start Spark. Find the class in the Eclipse Package Explorer, and open its context
-            menu (right-click on the file). In that menu, use the 'Run as Java Application' option. Eclipse wil start
+            menu (right-click on the file). In that menu, use the 'Run as Java Application' option. Eclipse will start
             to build Spark from the source code, after which Spark itself is started. If everything goes well, you will
             see the Spark login screen within a matter of seconds!
+            To see logs in the console you should specify VM option <code>-Ddebug.mode=true</code>.
         </p>
         <footer>
             <p>You can find more information on Spark at <a href="https://www.igniterealtime.org/projects/spark/">https://www.igniterealtime.org/projects/spark</a></p>

core/src/documentation/ide-intellij-setup.html

@@ -106,17 +106,18 @@
         </p>
 
         <figure>
-            <a href="images/IntelliJ-7.JPG"><img src="images/IntelliJ-7.JPG" alt="Launch the 'Startup' class as a Java application."></a>
+            <a href="images/IntelliJ-7.png"><img src="images/IntelliJ-7.png" alt="Launch the 'Spark' class as a Java application."></a>
-            <a href="images/IntelliJ-8.JPG"><img src="images/IntelliJ-8.JPG" alt="The Spark login screen, after launching the 'Startup' class."></a>
+            <a href="images/IntelliJ-8.JPG"><img src="images/IntelliJ-8.JPG" alt="The Spark login screen, after launching the 'Spark' class."></a>
             <figcaption>Run Spark straight from the source code.</figcaption>
         </figure>
 
         <p>
             The 'spark-core' module contains a class named <code>org.jivesoftware.Spark</code>
             that can be used to start Spark. Find the class in the Project Explorer, and open its context
-            menu (right-click on the file). In that menu, use the 'Run Startup.main()' option. IntelliJ wil start
+            menu (right-click on the file). In that menu, use the 'Run Spark.main()' option. IntelliJ will start
             to build Spark from the source code, after which Spark itself is started. If everything goes well, you will
             see the Spark login screen within a matter of seconds!
+            To see logs in the console you should specify VM option <code>-Ddebug.mode=true</code>.
         </p>
         <footer>
             <p>You can find more information on Spark at <a href="https://www.igniterealtime.org/projects/spark/">https://www.igniterealtime.org/projects/spark</a></p>

core/src/documentation/ide-vscode-setup.html

@@ -101,8 +101,8 @@
         </p>
 
         <figure>
-            <a href="images/VSCode-5.png"><img src="images/VSCode-5.png" alt="Launch the 'Startup' class as a Java application."></a>
+            <a href="images/VSCode-5.png"><img src="images/VSCode-5.png" alt="Launch the 'Spark' class as a Java application."></a>
-            <a href="images/VSCode-6.png"><img src="images/VSCode-6.png" alt="The Spark login screen, after launching the 'Startup' class."></a>
+            <a href="images/VSCode-6.png"><img src="images/VSCode-6.png" alt="The Spark login screen, after launching the 'Spark' class."></a>
             <figcaption>Run Spark straight from the source code.</figcaption>
         </figure>
 
@@ -112,6 +112,7 @@
             the main method, like in the picture above. You can click on <code>Run</code> and the code will be compiled and executed. VS Code will start
             to build Spark from the source code, after which Spark itself is started. If everything goes well, you will
             see the Spark login screen within a matter of seconds!
+            To see logs in the console you should specify VM option <code>-Ddebug.mode=true</code>.
         </p>
         <footer>
             <p>You can find more information on Spark at <a href="https://www.igniterealtime.org/projects/spark/">https://www.igniterealtime.org/projects/spark</a></p>