Trim README to essentials now that the underlying issues are fixed - #13
Merged
Conversation
The Installation and Domain-name curation sections had accumulated a lot of live-debugging narrative (step-by-step Rosetta/terminal diagnostics, uv cache-clearing commands, OpenMP/CMake technical explanations, "if this hangs/fails" caveats) written while tracking down real issues over several releases (#3-#12). Now that those are actually fixed -- FastTree auto-provisions itself, veryfasttree is correctly platform-gated, Gemini curation has a bounded timeout and automatic fallback -- that troubleshooting detail is no longer something a new user needs to read to get started; it's history, not instructions. Cut it down to what's actually necessary to install and use CANDy, with a clear, short Windows vs. macOS distinction, and add an explicit --curation-backend gemini command-line example. Co-Authored-By: Claude Sonnet 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
The Installation and Domain-name curation sections had accumulated a lot of live-debugging narrative written while tracking down real issues across several releases (#3-#12): step-by-step Rosetta/terminal diagnostics,
uvcache-clearing commands, OpenMP/CMake technical explanations, "if this hangs/fails" caveats. Now that those are actually fixed -- FastTree auto-provisions itself, veryfasttree is correctly platform-gated, Gemini curation has a bounded timeout and automatic fallback -- that's no longer something a new user needs to read; it's history, not instructions.--curation-backend geminicommand-line example (previously only implied through prose)Net: 199 -> 131 lines.
Test plan
pytest-- 142 passed (README-only change, no code touched)