Repository navigation
Document TeX Live installation and fix CTAN links - #2
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The documentation changes are consistent, accurate, and limited in scope.
0 open findings
What changed in this PR
Documents package installation and makes README resources usable from CTAN-rendered contexts.
Changes:
- Adds TeX Live, OS-managed, and manual installation guidance.
- Replaces relative resource links and an unsupported anchor link.
| File | Description |
|---|---|
terminaltrees-doc.tex |
Expands installation instructions. |
README.md |
Updates installation guidance and external links. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Owner
Author
|
Thanks for the review. No findings need changes. The check passed on e3e51d9. CTAN rendering will be verified after the documentation update is submitted. |
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.
Summary
Document TeX Live installation and make README links work independently of CTAN's relative-path and heading-anchor handling.
tlmgr install terminaltrees, with guidance for OS-managed installations and a manual fallback.The package code, tree geometry, and image-generation workflow are unchanged.
Verification
python3 terminaltrees-tests/check.py --preview, including all ten expected rejection cases.The install test reused existing dependencies. TeX Live reported a missing repository signing key; the installed package matched the released source byte-for-byte. MiKTeX and Overleaf execution were not tested. CTAN's rendered README needs a separate check after submission.