{"id":50692369,"url":"https://github.com/yl0711-coder/readme-roast","last_synced_at":"2026-06-09T04:08:49.566Z","repository":{"id":353098664,"uuid":"1217967446","full_name":"yl0711-coder/readme-roast","owner":"yl0711-coder","description":"Roast README drift or report it strictly by checking local links, paths, and project tree examples.","archived":false,"fork":false,"pushed_at":"2026-04-22T12:06:32.000Z","size":11,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-22T14:10:45.892Z","etag":null,"topics":["cli","developer-tooling","documentation","markdown","python","readme"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yl0711-coder.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-22T11:59:20.000Z","updated_at":"2026-04-22T12:07:13.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/yl0711-coder/readme-roast","commit_stats":null,"previous_names":["yl0711-coder/readme-roast"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/yl0711-coder/readme-roast","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yl0711-coder%2Freadme-roast","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yl0711-coder%2Freadme-roast/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yl0711-coder%2Freadme-roast/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yl0711-coder%2Freadme-roast/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yl0711-coder","download_url":"https://codeload.github.com/yl0711-coder/readme-roast/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yl0711-coder%2Freadme-roast/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34090905,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","developer-tooling","documentation","markdown","python","readme"],"created_at":"2026-06-09T04:08:49.042Z","updated_at":"2026-06-09T04:08:49.561Z","avatar_url":"https://github.com/yl0711-coder.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# README Roast\n\n[English](README.md) | [简体中文](README.zh-CN.md)\n\n## One-Line Idea\n\nRoast a repository README like a mean reviewer, or switch to strict mode and turn the jokes into actionable checks.\n\n## Why It Exists\n\nMany repositories have README files that sound confident but drift away from reality:\n\n- install steps no longer work\n- paths in the docs do not exist\n- repository structure examples are outdated\n- package metadata and README disagree\n\nThis project turns that pain into a fun local tool.\n\n## Core Modes\n\n- `roast`: funny output\n- `review`: serious output\n- `strict`: CI-friendly failure mode\n\n## MVP\n\n- detect local README links that point to missing files\n- detect obvious referenced paths that do not exist\n- detect project tree snippets that mention missing directories\n- output funny roast lines\n- output strict machine-readable findings\n\n## Status\n\nCurrent version: `v0.1.1`\n\nFirst version scope:\n\n- local README path truth-checking only\n- no network access\n- no remote link validation\n- no package-manager-specific checks yet\n- no automatic fixes\n\nVersion `v0.1.1` also understands local links with fragments or query strings, such as `CHANGELOG.md#v011---2026-05-08`, and ignores non-file links such as `mailto:`.\n\n## Good Fit\n\n- Python\n- single CLI\n- no network\n\n## Non-Goals\n\n- full Markdown parser with every edge case\n- remote HTTP link checker\n- full package manager validation replacement\n\n## First Demo\n\nRun it against intentionally messy repositories and produce:\n\n- a roast screenshot\n- a strict report screenshot\n\n## Usage\n\n```bash\nbin/readme-roast\nbin/readme-roast --mode review\nbin/readme-roast --json\nbin/readme-roast --strict\nbin/readme-roast --readme README.zh-CN.md --mode review\nbin/readme-roast /path/to/repo --mode review --strict\n```\n\nExit codes:\n\n- `0`: command ran successfully\n- `1`: findings present in `--strict` mode\n- `2`: invalid input such as missing `README.md`\n\n## What It Checks\n\n- local Markdown links such as `[Changelog](CHANGELOG.md)`\n- local Markdown links with anchors such as `[Changelog](CHANGELOG.md#v011---2026-05-08)`\n- obvious inline path references such as `` `scripts/dev.py` ``\n- project tree entries inside README code blocks\n\n## Development\n\n```bash\nPYTHONPATH=src python -m unittest discover -s tests\nbin/readme-roast --mode review --strict\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyl0711-coder%2Freadme-roast","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyl0711-coder%2Freadme-roast","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyl0711-coder%2Freadme-roast/lists"}