docs: add image-tool README#478
Open
x-n2o wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds the missing documentation page for the image-tool example so the top-level README link no longer 404s, and credits the documentation contribution in acknowledgments.
Changes:
- Add
Tools/image-tool/README.mddocumenting how to build/runimage-tooland usesd text/sd imagecommands and options. - Update
ACKNOWLEDGMENTS.mdto include the new documentation contributor.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| Tools/image-tool/README.md | New image-tool usage/build/run documentation and examples. |
| ACKNOWLEDGMENTS.md | Adds contributor entry for the documentation update. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Proposed changes
Fixes #477.
Adds the missing
Tools/image-tool/README.mdso the top-levelREADME.mdlink forimage-toolresolves. The new README documents building the scheme, running through Xcode andmlx-run, text-to-image usage, image-to-image usage, common generation options, and model/memory options.Also updates
ACKNOWLEDGMENTS.mdfor the documentation contribution.Checklist
Put an
xin the boxes that apply.pre-commit run --all-filesto format my code / installed pre-commit prior to committing changes