Skip to content

Enhance README with Python bindings and visualisation details#184

Merged
sebschmi merged 3 commits into
mainfrom
better-readme
May 19, 2026
Merged

Enhance README with Python bindings and visualisation details#184
sebschmi merged 3 commits into
mainfrom
better-readme

Conversation

@sebschmi
Copy link
Copy Markdown
Collaborator

Add Python bindings section and update visualisation instructions

Add Python bindings section and update visualisation instructions
Copilot AI review requested due to automatic review settings May 19, 2026 07:50
@sebschmi sebschmi enabled auto-merge May 19, 2026 07:51
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 X but the description refers to x), 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 -ps parses, using the same style throughout the README would reduce ambiguity (especially since -s takes 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.

Comment thread README.md Outdated
Comment thread README.md
sebschmi and others added 2 commits May 19, 2026 11:47
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Updated feature descriptions for clarity and consistency.
@sebschmi sebschmi merged commit 9397e93 into main May 19, 2026
28 checks passed
@sebschmi sebschmi deleted the better-readme branch May 19, 2026 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants