Skip to content

Improve README presentation#16

Merged
shaypal5 merged 1 commit into
mainfrom
codex/improve-hletterscript-readme-presentation
May 31, 2026
Merged

Improve README presentation#16
shaypal5 merged 1 commit into
mainfrom
codex/improve-hletterscript-readme-presentation

Conversation

@shaypal5
Copy link
Copy Markdown
Contributor

@shaypal5 shaypal5 commented May 31, 2026

Summary

  • Rework the README into a clearer first-visit gateway for the hletterscript seed corpus.
  • Add badges, exact corpus counts, pipeline positioning, dataset layout, licensing, validation, and contribution guidance.
  • Add a real sample grid generated from the indexed crop PNGs so visitors can immediately see the dataset shape.
  • Add the required creator attribution near the top and in a bottom Credits section.
  • Pin the upstream HASH checkout used by CI to the latest referenced HASH commit so cross-validation stays reproducible.
  • Update repository metadata description and topics to match the project purpose.

Validation

  • python3 scripts/validate_indexes.py
  • python3 scripts/validate_indexes.py --upstream-path <temporary HASH worktree at 0e162a78d609a47858c460431be3d689b2e9e31e>
  • python3 scripts/generate_release_artifacts.py --check
  • python3 -m pytest
  • git diff --check
  • README smoke check for exactly two creator mentions and bottom Credits placement

Notes

No open GitHub milestones are available for this repository, so no milestone was assigned.

@shaypal5 shaypal5 added the documentation Improvements or additions to documentation label May 31, 2026
@shaypal5 shaypal5 force-pushed the codex/improve-hletterscript-readme-presentation branch from 6ffd0bc to cb99db5 Compare May 31, 2026 05:18
@shaypal5 shaypal5 merged commit 94ff4b3 into main May 31, 2026
3 checks passed
@shaypal5 shaypal5 deleted the codex/improve-hletterscript-readme-presentation branch May 31, 2026 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant