Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 48 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,58 @@ jvm --help

## Development

To build the project simply run:
### Prerequisites

- **Java 11+** — required to compile and run (`JAVA_HOME` must be set)
- **Maven** — provided via the included wrapper (`mvnw` / `mvnw.cmd`), no separate install needed

### Building

Full build with formatting and tests:

```shell
./mvnw spotless:apply clean verify
```
mavern have

Quick build, skipping tests:

```shell
./mvnw clean package -DskipTests
```

The build produces two JARs in `target/`:

- `jvm-<version>.jar` — thin JAR (no bundled dependencies)
- `jvm-<version>-cli.jar` — fat JAR, runnable directly

### Running the Built Artifact

```shell
java -jar target/jvm-<version>-cli.jar --help
java -jar target/jvm-<version>-cli.jar --version
java -jar target/jvm-<version>-cli.jar list
```

Or use the assembled launcher from `target/binary/bin/`:

```shell
# Linux/macOS
./target/binary/bin/jvm --help
# Windows
target\binary\bin\jvm.bat --help
```

### Code Formatting

The project uses [Spotless](https://github.com/diffplug/spotless) with Google Java Format (AOSP style).

```shell
# Apply formatting
./mvnw spotless:apply
# Check without modifying
./mvnw spotless:check
```

### Building Native Executables

The project supports building native executables using GraalVM. This creates a standalone binary with faster startup time and lower memory footprint.
Expand Down