docs: update build commands (build, build-classes, clean, jars) - #325
Merged
Conversation
The `build` command no longer writes class files; the new `build-classes` command does. The `build-jar` and `build-fatjar` commands compile the project themselves and do not touch the `build` directory. Also documents the `clean` command. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the build documentation to match flix/flix#13019, flix/flix#13020 and flix/flix#13021:
buildnow only compiles the project (nothing is written to disk).build-classescommand: compiles the project and writes the class files tobuild/class; documented withjava -cp build/class Main.build-jar/build-fatjarcompile the project themselves and no longer read from (or write to) thebuilddirectory; the "automatically invokes thebuildcommand" notes are replaced accordingly. The thin jar description also mentions theresourcesdirectory.cleancommand" with a description ofclean, and notes thatclean(likebuild-pkg) requires a manifest.build-and-packages.md: command list updated withbuild-classesandclean.🤖 Generated with Claude Code