Improve README readability#10
Draft
gary149 wants to merge 5 commits into
Draft
Conversation
The old README had a sentence-long title, buried the quickstart, missed key flags (--top, explicit model), and didn't document auto-install behavior, server reuse, log location, or LLAMA_SERVER_TIMEOUT.
gary149
changed the title
Reduce from 103 lines / 7 sections to 56 lines / 4 sections. Remove "How it works" step list, dependencies table, and H3 subsections. Collapse config into a details element. Move component credits to footer as attribution.
hanouticelina
approved these changes
Mar 20, 2026
| ```bash | ||
| # install the HF CLI | ||
| curl -LsSf https://hf.co/cli/install.sh | bash | ||
| # install the hf-agents extension |
Collaborator
There was a problem hiding this comment.
let's mention that hf extensions install hf-agents --force is the workaround to upgrade the extension (we don't have hf extensions upgrade yet but it's planned)
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
2 participants
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
run piflow--top N, explicit model arg, Pi arg forwardingLLAMA_SERVER_TIMEOUTenv varTest plan