docs: clarify model.gguf placeholder in all README examples#19
Merged
Conversation
A user reported confusion: the Advanced Usage / Docker / Server / Python / single-header examples all referenced 'model.gguf' as if it were a real file, but the Quick Start downloads SmolLM2-135M-Instruct-Q8_0.gguf, not a file literally named model.gguf. New users were trying to rename the downloaded file. Replace the bare 'model.gguf' literal across both READMEs: - Advanced Usage block: introduce a MODEL=... shell variable plus an explicit note that the user must point it at their own GGUF. - Docker / quant-server: use the SmolLM2 path from Quick Start with a comment instructing users to substitute their own GGUF. - Python / single-header C examples: use 'path/to/your.gguf' with an inline comment. No code changes; documentation clarity only. Co-Authored-By: Claude Opus 4.6 (1M context) <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
User feedback from Reddit: the Advanced Usage examples reference
model.ggufas if it were a real file, but the Quick Start downloadsSmolLM2-135M-Instruct-Q8_0.gguf. New users were trying to rename the file.MODEL=...shell variable with an explicit note explaining the placeholderpath/to/your.ggufwith inline commentsREADME.md(EN) andREADME.ko.md(KO)No stale
model.ggufreferences remain in either file.Test plan
grep -n 'model\.gguf' README.md README.ko.mdreturns no matches🤖 Generated with Claude Code