From e5d3af55a44d3e0c0eecc8c5fd3bab2abf2d3177 Mon Sep 17 00:00:00 2001 From: Sergey Ponomarev Date: Tue, 21 Apr 2026 14:59:40 +0300 Subject: [PATCH] docs: Add -Ddebug.mode=true, improve README --- README.md | 29 +++++++++--------- core/src/documentation/ide-eclipse-setup.html | 7 +++-- .../src/documentation/ide-intellij-setup.html | 7 +++-- core/src/documentation/ide-vscode-setup.html | 5 +-- core/src/documentation/images/IntelliJ-7.JPG | Bin 85033 -> 0 bytes core/src/documentation/images/IntelliJ-7.png | Bin 0 -> 145660 bytes 6 files changed, 26 insertions(+), 22 deletions(-) delete mode 100644 core/src/documentation/images/IntelliJ-7.JPG create mode 100644 core/src/documentation/images/IntelliJ-7.png diff --git a/README.md b/README.md index 6fb25feb8..a63bdd6f8 100644 --- a/README.md +++ b/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) -or [nightly build](https://igniterealtime.org/downloads/nightly_spark.jsp) with latest changes. -For Windows, if you are not sure, if it's recommended to download the `spark_*-64bit.msi`. -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). +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 the latest changes. +For Windows, if you are not sure, if it's recommended to download the ` spark_*-with-jre-amd64.exe` that has bundled JRE. Screenshots --------- @@ -63,16 +61,19 @@ Run from sources ---------------- ```bash -$ git clone https://github.com/igniterealtime/Spark.git -$ cd Spark/core -$ mvn exec:java +git clone https://github.com/igniterealtime/Spark.git +mvn verify +cd Spark/core +mvn exec:java ``` -* Setup IDE with the source: - * [Intellij](https://download.igniterealtime.org/spark/docs/latest/documentation/ide-intellij-setup.html), +To run from an IDE execute the Main class `org.jivesoftware.Spark` and specify VM option `-Ddebug.mode=true`. + +* 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) diff --git a/core/src/documentation/ide-eclipse-setup.html b/core/src/documentation/ide-eclipse-setup.html index c9b1752a5..f24c83bad 100644 --- a/core/src/documentation/ide-eclipse-setup.html +++ b/core/src/documentation/ide-eclipse-setup.html @@ -98,17 +98,18 @@

- Launch the 'Startup' class as a Java application. - The Spark login screen, after launching the 'Startup' class. + Launch the 'Spark' class as a Java application. + The Spark login screen, after launching the 'Spark' class.
Run Spark straight from the source code.

The 'spark-core' module contains a class named org.jivesoftware.Spark 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 -Ddebug.mode=true.