Repository navigation
docs: refresh the README for GitHub, npm and NuGet - #2962
Merged
Merged
Conversation
Restructure the README as a landing page: tagline and pitch, version and download badges, a link row, a hero image rendered by alphaTab from the Iron Waltz demo song, highlights, supported formats, a runnable CDN quick start, a platforms table, the packages in this repository, documentation links, community, licensing and thanks. All links and images are absolute and the markup is plain Markdown, so the same file renders on GitHub, npmjs.com and nuget.org, which ship it verbatim. Also update the npm description and keywords of @coderline/alphatab.
Add `npm run readme-hero`, which renders a passage of a song with alphaTab in Node and composes it into a player window, written as a single self-contained SVG with light and dark colors selected via prefers-color-scheme. A custom render engine outlines all text and music symbols with the fonts bundled in packages/alphatab/font and measures text with the same fonts, so layout and outlines match and the image needs no fonts where it is embedded. Glyph outlines are shared through <defs>. Timing, section labels and the waveform come from the song and its backing track (decoded with ffmpeg). img/hero.svg is generated from the Iron Waltz demo song.
The SVG follows the viewer's light or dark theme and is smaller than the PNG it replaces.
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.
Note
AI-authored disclosure (
alphatab-ai-authored-v1)Portions of this content were authored by an AI agent. The agent has read
AGENTS.md and the human submitter accepts responsibility for
compliance with the rules in that document.
Issues
Fixes #
Proposed changes
The README is the landing page on GitHub, and the same file ships verbatim in the npm package and both NuGet packages. The current one is outdated: it lists Guitar Pro 3–7, leaves out Capella, has no code sample and still shows netcoreapp3.1 platform rows.
This PR restructures it as a modern landing page:
prefers-color-scheme. All text and music symbols are outlined, so it needs no fonts wherever it is embedded.npm run readme-hero -- --song <file>regeneratesimg/hero.svg. It renders the passage with alphaTab in Node through a custom render engine. That engine outlines text and Bravura symbols with the fonts bundled inpackages/alphatab/fontand measures text with the same fonts, so layout and outlines match. Timing, section labels and the waveform come from the song and its backing track (decoded withffmpeg).opentype.js(MIT) is added as a root devDependency for the outlines. The song itself is not part of the repository.npm installand a runnable CDN snippet, a platforms table, the packages in this repository, documentation links (includingllms.txt), community links including Show and tell, licensing of the bundled fonts and SoundFont, and thanks.<picture>, so the file renders the same on all three.descriptionandkeywordsfor@coderline/alphatab.The hero URL points at
develop, so the image only appears in the rendered README once this is merged.Checklist
AI authorship disclosure
(
alphatab-ai-authored-v1) is present at the top of this body, and I havepersonally reviewed every change and can explain each one
Further details