Skip to content

docs: expand Development section with build process documentation#44

Closed
simond4680-sys wants to merge 1 commit intocodejive:mainfrom
simond4680-sys:docs/build-process
Closed

docs: expand Development section with build process documentation#44
simond4680-sys wants to merge 1 commit intocodejive:mainfrom
simond4680-sys:docs/build-process

Conversation

@simond4680-sys
Copy link
Copy Markdown

Summary

Expands the Development section of the README with complete build process documentation.

Changes

  • Prerequisites — Java 11+ and Maven wrapper requirements
  • Building — full build (spotless:apply clean verify) and quick build (-DskipTests) with artifact descriptions for both the thin JAR and fat CLI JAR
  • Running — how to invoke the built artifact directly via java -jar and via the assembled launcher in arget/binary/bin/
  • Code Formatting — spotless:apply vs spotless:check usage
  • Typo fix — removed stray \mavern have\ text from the original Development section

Verification

The documented commands were verified against a successful local build producing \jvm-0.3.1-SNAPSHOT-cli.jar, confirmed runnable with --version\ and --help.


Warp conversation

Co-Authored-By: Oz oz-agent@warp.dev

Add prerequisites, build commands, artifact descriptions, run
instructions, and code formatting guidance. Fix stray 'mavern have'
typo in the original Development section.

Co-Authored-By: Oz <oz-agent@warp.dev>
@simond4680-sys simond4680-sys deleted the docs/build-process branch May 7, 2026 20:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant