From 49cac8dac0437ae013e69ffb59478c4ef08ef876 Mon Sep 17 00:00:00 2001
From: mikera <mike@mikera.net>
Date: Fri, 3 May 2024 15:20:58 +0100
Subject: [PATCH] Edit Convex Desktop README

---
 convex-gui/README.md | 40 +++++++++++++++++++++++++---------------
 1 file changed, 25 insertions(+), 15 deletions(-)

diff --git a/convex-gui/README.md b/convex-gui/README.md
index dee15ed2d..08ba57ebc 100644
--- a/convex-gui/README.md
+++ b/convex-gui/README.md
@@ -1,6 +1,15 @@
 # Convex Desktop GUI
 
-A desktop interface for interacting with Convex.
+Convex Desktop is a full featured desktop application for working with Convex. It is intended for developers who wish to build solutions on Convex as well as power users who wish to work directly with assets and smart contracts on the Convex Network.
+
+Key features:
+- Execute transactions on Convex networks
+- Secure key generation and wallet management
+- Run a local network of Convex Peers
+- Visualisation of CPoS consensus and network messaging
+- Simulations and stress test code
+
+![Screenshot](docs/images/convex-desktop.png)
 
 ```
 Unleash the power of the Convex decentralized network directly from your desktop. The Convex GUI 
@@ -14,31 +23,32 @@ Download the Convex GUI today.
 - Google Gemini
 ```
 
-![Screenshot](docs/images/convex-desktop.png)
+## Usage
 
-## Overview
+### Building
 
-Convex Desktop is a full features desktop application for working with Convex. It is intended for developers who wish to build solutions on Convex as well as power users who wish to work directly with assets and smart contracts on the Convex Network.
+You can build Convex Desktop as follows:
 
-Key features:
-- Execute transactions on Convex networks
-- Secure key generation and wallet management
-- Run a local network of Convex Peers
-- Visualisation of CPoS consensus and network messaging
-- Simulations and stress test code
+- Download the convex repository via git `https://github.com/Convex-Dev/convex.git`
+- Run `mvn install` in the root directory (this will build all Convex modules)
+- The Convex Desktop `.jar` file should be created at `convex-gui/target/convex-desktop.jar` 
 
-## Usage
+### Running Convex Desktop
 
-### Local peer operation
+If Java is properly installed on your machine, you should be able to run the `convex-desktop.jar` file directly as a Java application (double click on Windows).
 
-Run the main class `convex.gui.manager.PeerGUI`.
+Alternatively, from the command line you can run the main class `convex.gui.MainGUI`, with a Java command such as:
+
+```bash
+java -jar convex-desktop.jar
+```
 
-This launches the GUI application, which defaults to running a small local network of Peers.
+This launches the Convex Desktop application main screen.
 
 ### Flight recorder
 
 ```
-java -cp target/convex-gui-jar-with-dependencies.jar -XX:+FlightRecorder -XX:StartFlightRecording=duration=200s,filename=flight.jfr convex.gui.manager.PeerGUI
+java -cp target/convex-gui-jar-with-dependencies.jar -XX:+FlightRecorder -XX:StartFlightRecording=duration=200s,filename=flight.jfr convex.gui.MainGUI
 ```
 
 ## License