Skip to content

Commit e6cb630

Browse files
committed
Main README updates
1 parent 3850120 commit e6cb630

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,36 +61,47 @@ For making use of Convex data structures, CVM execution etc. locally you probabl
6161

6262
## Running Convex
6363

64+
### Download
65+
66+
Recent development snapshot builds of `convex.jar` are made available here:
67+
68+
- [Snapshots](https://drive.google.com/drive/folders/1AZdyuZOmC70i_TtuEW3uEKvjYLOqIMiv?usp=drive_link)
69+
6470
### Building locally
6571

66-
To get a local development build of Convex you need [git](https://git-scm.com/) and [Apache Maven](https://maven.apache.org/). You will also need a recent version of Java ([JDK 21+ recommended](https://www.oracle.com/java/technologies/downloads/), though anything from 17 onwards should be supported)
72+
To get a local development build of Convex you need [git](https://git-scm.com/) and [Apache Maven](https://maven.apache.org/). You will also need a recent version of Java ([JDK 21+ recommended](https://www.oracle.com/java/technologies/downloads/).
6773

6874
1. Clone [this repository](https://github.com/Convex-Dev/convex) using `git` - you probably want the `develop` branch (the default)
6975
2. Build using `mvn install` in the root directory
7076

7177
This should download all necessary dependencies and perform a standard build.
7278

73-
### Convex Desktop
79+
### Running Convex Desktop
7480

75-
Convex Desktop is a GUI application for power users and developers providing full access to the capabilities of Convex. To run, you will need a modern version of Java installed (21+) and the `convex-desktop.jar` executable file (which can be found in the outputs of the Maven build above, or downloaded from trusted sources).
81+
Convex Desktop is a GUI application for power users and developers providing full access to the capabilities of Convex. To run, you will need a modern version of Java installed (21+) and the `convex.jar` executable file (which can be found in the outputs of the Maven build above, or downloaded from trusted sources).
82+
83+
If Java is correctly installed, you should be able to double-click the executable `convex.jar` file to run it. Depending on your security settings, you may need to grant approval for this to run.
84+
85+
Alternatively, run Convex Desktop using `java` at the command line as follows:
7686

7787
```bash
78-
java -jar convex-desktop.jar
88+
java -jar convex.jar desktop
7989
```
8090

81-
### Command Line Interface (CLI)
91+
### Running the Convex Command Line Interface (CLI)
8292

83-
If you have an already built version of the Convex CLI `convex-cli.jar` file and installed a recent version of Java you can run it as follows:
93+
If you have an already built version of the Convex CLI `convex.jar` file and installed a recent version of Java you can run it as follows:
8494

8595
```bash
86-
java -jar convex-cli.jar <optional args>
96+
java -jar convex.jar <optional args>
8797
```
8898

8999
For convenience, there are shell scripts to automate this for common platforms in the root directory of this repo, e.g.
90100

91101
```bash
92102
./convex --help
93103
```
104+
94105
Using the CLI, you can start the Convex Desktop GUI for a local peer test network by using the `local gui` command:
95106

96107
```

0 commit comments

Comments
 (0)