Skip to content

Remove 'Get started' section from README #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DanielThomas merged 1 commit into from
Sep 17, 2026
Merged

Remove 'Get started' section from README #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 0 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,21 +32,6 @@ Follow the `ja` [Installation Guide](https://github.com/Netflix/ja#installation)

For standalone use, `jar` and `jmod` artifacts for the tool are available on Maven Central.

## Get started

Start with an application JAR already available locally:

```sh
jig --module-path /path/to/com.example.app.jar \
--module com.example.app \
--resolve-options module-path,module=main \
--write-argfile /path/to/launch.args

java @/path/to/launch.args
```

The supplied JAR remains on the module path. Missing dependencies are resolved from Maven repositories using the versions recorded in their module descriptors. The generated argument file contains ordinary `java` options and can be combined with arguments supplied directly by the caller.

## Documentation

The [jig wiki](https://github.com/Netflix/jig/wiki) contains the complete documentation:
Expand Down