Skip to content

README.md: say how to take it into a project - #4

Merged
gafferongames merged 1 commit into
mainfrom
distribution-claims
Sep 4, 2026
Merged

README.md: say how to take it into a project#4
gafferongames merged 1 commit into
mainfrom
distribution-claims

Conversation

@gafferongames

Copy link
Copy Markdown
Contributor

Docs only. Part of a family-wide pass making every distribution claim honest against the registries.

The claims found. None — and that is the gap. The README's only distribution-adjacent line is "A plain Makefile drives everything — no Maven, no Gradle", under Toolchain, which is about developing this repo. There is no install line, no coordinate, no statement of what the library is distributed as, and nothing telling a reader how to get import serialize.*; (USAGE.md line 11) to compile in their own project.

The registry fact. Nothing on Maven Central. The Maven Central search for a:serialize returns three artifacts, all other people's (org.mvnpm.at.keyv, org.mvnpm.at.emotion, io.github.magicpluginteam); no group under mas-bandwidth exists. There is no pom.xml or Gradle file in the repo, so no coordinate has been chosen either.

Changed. A new ## Getting it section ahead of The surface: it ships as source today, the implementation is ready and the package is not yet published, there is no artifact on Maven Central under any coordinate and no Maven or Gradle build here to produce one, and publishing is a separate round. Then the two source paths, exact:

  • copy src/serialize/ (15 files, zero dependencies) into your own source tree;
  • or build a jar with the same javac line the Makefile uses — javac --release 17 -d classes serialize.java/src/serialize/*.java then jar cf serialize.jar -C classes serialize — and compile against -cp serialize.jar.

Plus the -ea / no--ea note that matches the two shapes the suite tests, and pin a tag, v1.1.0 current.

No version bumps, no code changes.

🤖 Generated with Claude Code

The README documented the pinned JDK and the Makefile — how to develop the
library — and never said how to consume it. A Getting it section now states
that it ships as source, that the implementation is ready and the package is
not yet published, and gives both source paths as exact lines.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@gafferongames
gafferongames merged commit c2ebcc9 into main Sep 4, 2026
3 checks passed
@gafferongames
gafferongames deleted the distribution-claims branch September 4, 2026 11:03
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