Skip to content

Commit 2b85370

Browse files
committed
docs(readme): benchmark-race hero, animated demos, Markdown conversion
Rewrite the README as Markdown with a measured-data wow layout and wire up the assets and gates that keep it honest: - README.md replaces README.rst: centered badge row, animated benchmark race hero, feature sections with animated SVG demos (colors, logs, multibar, parallel execution, pv-style CLI), verified stability numbers, retained reference content - benchmarks: measure plain progressbar2 and progressbar2[fast] separately in scenarios A and C, add speedups to requirements, refresh results/report/chart against current develop - scripts/render_race.py: deterministic race SVG generated from results.json, byte-drift gated in tox docs-demos next to render_demos --check - new registry demos readme/colors, readme/parallel and readme/cli with capture tests, README code blocks test-synced to the example sources - render_demos: drop rows that MultiBar clears so removed bars no longer linger as stale duplicate frames - fix(bar): NullBar.finish() now flips _finished, so a NullBar inside a MultiBar context cannot hang the exit wait (regression test included) - tox: new readme env builds the sdist and runs twine check --strict (with readme_renderer[md]) in CI
1 parent 885dd78 commit 2b85370

28 files changed

Lines changed: 1439 additions & 330 deletions

.github/workflows/main.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ jobs:
6666
- python-version: '3.14'
6767
tox-env: docs-linkcheck
6868
experimental: true
69+
- python-version: '3.14'
70+
tox-env: readme
6971
- python-version: '3.14'
7072
tox-env: ruff
7173
- python-version: '3.14'

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ recursive-exclude *.pyo
33
include CHANGES.rst
44
include CONTRIBUTING.rst
55
include LICENSE
6-
include README.rst
6+
include README.md
77
include examples.py
88
include pytest.ini

0 commit comments

Comments
 (0)