oil-oil GitHub avatar

beautify-github-readme

oil-oil

一个 GitHub Skill,通过理解项目、重构内容并生成项目原生的视觉资产(SVG 等)来重新设计仓库 README,且不虚构能力。

Stars

1,339

7 天增长

暂无数据

Fork 数

88

开放 Issue

1

开源协议

MIT

最近更新

2026-07-27

AI 仓库情报摘要
FR-AI / ANALYSIS

为什么值得关注

它解决了 README 对访客不清晰的常见问题:优先展示证据而非术语,将视觉身份(SVG)与可维护的 Markdown 分离,并已在四个采用不同视觉语言的公开仓库中实际应用。

适合谁使用

  • 希望让 README 更清晰的开源维护者
  • 频繁更新 README 的开发者
  • 希望跨仓库保持统一视觉风格的项目作者
  • 希望安全自动化改进 README 的 AI 代理用户

典型使用场景

  • 围绕项目的真实价值和证据重新设计整个 README
  • 仅生成视觉资产(SVG 英雄区、图表、动效)而不修改文本
  • 运行只读审计以评估清晰度、层级、信任度和维护成本
  • 创建项目原生的英雄区,从项目自身提取排版、色彩和构图

项目优势

  • 已被四个不同视觉风格的公开仓库(oil-ppt、draw-ui、oil-icon、Selector、torqueDASH-Next)实际使用
  • 将视觉层(SVG)与内容(Markdown)分离,保持 README 可搜索且易维护
  • 提供明确的“全文”和“仅资产”两种模式,支持本地预览且不会自动提交
  • 包含只读审计功能,不修改任何文件

使用前须知

  • 需要通过 npx 或代理安装该 Skill,增加了一个设置步骤
  • 输出质量依赖于项目现有材料的丰富程度——极为精简的仓库可能改进有限
  • 该方法强调设计决策,当项目缺乏明确身份时可能需要迭代反馈

README 快速开始

English · 简体中文 · 日本語

These are not hypothetical templates. The method is already used by eight public repositories, each with its own visual language and content structure:

  • oil-ppt — presents the method, results, and first-use path for programmatic slide creation in one visual system.
  • draw-ui — uses real UI outputs to explain the path from a brief and reference images to HTML/CSS reconstruction.
  • oil-icon — uses real icon sets to explain style locking, batch generation, slicing, and transparent delivery.
  • Selector — puts page selection, structured context, and real output directly into the opening screen and examples.
  • codex-dev-team — uses a character-driven team map to explain how one main Codex thread delegates exploration, bounded implementation, and independent review to four custom agents.
  • torqueDASH-Next — uses a project-native SVG hero with OBD-II PID data and a real dashboard screenshot to explain a self-hosted vehicle telemetry dashboard.
  • summertown — uses a seaside-map hero and landmark showcase to introduce an interactive town map.
  • Wolfcha — combines SVG typography and an AI-generated character cutout to turn “play Werewolf solo” into a cinematic, project-native opening screen.

If this Skill helped you create a public README you are proud of, you are welcome to propose it for this list in a PR. This is completely optional: the footer signature is appreciated but never required, and showcase submissions remain subject to maintainer review.

Below are four independent hero directions. They do not share one house style; each derives its typography, color, composition, and proof from the project itself.

Block World shows a playful hybrid direction: SVG builds the pixel typography, grid, labels, and scene structure, while ImageGen and chroma-key removal supply the character that would be cumbersome to draw deterministically.

Wolfcha is a real hybrid case: ImageGen created the project-

项目描述

Design clear, theme-specific GitHub README homepages with SVG titles, real proof, and maintainable Markdown

相关仓库与替代方案

根据分类、Topic 和编程语言匹配的相似项目。

powerycy
精选
powerycy GitHub avatar

goutoujunshi

An AI relationship coach that provides emotional support, relationship science, and actionable strategies through a multidisciplinary knowledge base.

Python
1,174
HezaoHezao
精选
HezaoHezao GitHub avatar

poirot

Poirot is a deep research agent kernel with a middleware-first architecture, five-layer long-term memory, multi-agent orchestration, sandbox isolation, and a three-layer skill self-evolution system, backed by 2400+ tests.

AI 与机器学习大语言模型
25
lopopolo
精选
lopopolo GitHub avatar

harness-engineering

Harness Engineering is a methodology for improving coding agent outputs by carefully crafting the environment around them—providing curated context, tools, and executable constraints that encode an organization’s nonfunctional requirements and cumulative lessons.

AI 与机器学习AI 智能体
2,390