Enhance README with Python bindings and visualisation details#184
Merged
Conversation
Add Python bindings section and update visualisation instructions
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the project README to surface the existence of PyPI-hosted Python bindings and to refine the alignment visualisation instructions, focusing on SVG/PNG outputs.
Changes:
- Add PyPI badges and a short “Python bindings” installation section.
- Update the visualisation documentation and CLI examples for generating SVG/PNG output.
- Reformat the “embedded rq ranges” example to use a dedicated shell code block.
Comments suppressed due to low confidence (2)
README.md:136
- For
-z, the placeholder is inconsistent (-z Xbut the description refers tox), and “TSM(s)” is not defined anywhere else in the README. Consider using a consistent placeholder (e.g.,-z N) and expanding the acronym (e.g., “template switches”).
* `-z X` renders only `x` bases of context around the TSMs
README.md:139
- The example uses combined short options (
-ps visualisation.svg) while earlier examples use-p -s visualisation.svg. Even if-psparses, using the same style throughout the README would reduce ambiguity (especially since-stakes a value).
tsalign show -i alignment.toml -n alignment-no-ts.toml -ps visualisation.svg -ace -z 5
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Updated feature descriptions for clarity and consistency.
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.
Add Python bindings section and update visualisation instructions