Lov Better Readme

Organization

lovstudio

lov-better-readme

依据项目代码完善 README、安装说明、使用示例与真实品牌资产。支持明确输入与结果回读。Use to create or improve a project README.

Overview

Publisher	lovstudio
Repository	`skills`
Skill name	`lov-better-readme`
Stars	67
Forks	17
Bundled files	11
License	MIT
Links	Skill source Repository Homepage

Markdown instructions
A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.
Works with any LLM
AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.
11 bundled files
Scripts, templates, and references the model can read while it works. Files are read-only and never executed.
Open source
Published by lovstudio on GitHub. Read the source before you install it.

Installation

Install the Lov Better Readme AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

Open the app and go to Plugins → Skills.
Choose "Install from GitHub".
Paste the skill folder URL below and confirm.
Enable the skill in any chat where you want it available.

Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills

git clone --depth 1 https://github.com/lovstudio/skills.git /tmp/skills
mkdir -p .claude/skills
cp -r /tmp/skills/skills/better-readme .claude/skills/lov-better-readme

Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Lov Better Readme in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Lov Better Readme on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Lov Better Readme is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

Loaded only when it is needed
The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.
Switch models mid-chat
Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

README 精修 · README Polish

依据项目代码完善 README、安装说明、使用示例与真实品牌资产。

Triggers

Activate when

“依据项目代码完善 README、安装说明、使用示例与真实品牌资产。”
“Create or improve a project README.”

Do not activate when

只是查询本 Skill 的说明，或请求与上述结果无关的任务；不执行实际业务操作。
用户仅要预览或审查时，不进入修改、提交或发布分支。

Execution boundary

自然语言请求即可触发；无需旧 slash 路径、参数插值或指定助手。明确解析当前请求中的项目、目标文件、选项与输出位置；用当前宿主实际提供的文件、搜索、CLI 和浏览器能力。项目依赖版本与外部 API 在执行时核实，不能假设示例是现行配置。随包脚本从 Skill 根解析，业务文件从目标项目根解析。先读当前状态，保护已有未提交内容与其他任务的暂存区。分析、预览请求保持只读；修改、提交、推送、部署和发布各依当前请求的明确范围执行。不绕过保护、自动发送消息、强制结束用户进程或抢前台。失败保留可诊断原始错误。

Workflow

读取现有 README、manifest、入口、实际 scripts、许可与远程仓库；保留已有有效内容和用户改动。根 README 写仓库级信息，单项功能细节放相应文档并链接。
用一句话说明用途，再给真实可执行的安装、快速开始、主要功能、使用示例、技术栈与许可。只有实际支持时列快捷键、平台、下载与截图。
保留现有封面和 Logo。需要补图时使用当前可用生成能力，封面可放 docs/images/cover.png；品牌从 Profile 或项目资产解析，不硬编码色值。已有资产不因优化文案而自动重画。
可使用同排 32px Logo 和 h1、strong 简介及平台 sub 文本；GitHub 会限制样式，优先普通 Markdown 与支持的 HTML 属性。修复所有本地图片和锚点链接，不添加占位图服务。
从项目 LICENSE 读取许可；缺失时说明未声明，不能擅自授予 Apache 或其他许可。仅公开仓库且有展示价值时添加已核验 owner/repo 的 Star History。
验证文档命令、路径与版本；提交和推送仅在请求包含这些动作时执行，使用本次确切文件清单，不 squash 已发布历史。

Composition

执行前读取能力组合，按明确制品交接相邻能力。

Runtime context (shared)

运行前读取本包 skill.yaml 与 Profile 合同。优先级为当前请求、项目上下文、本 Skill records、共享 preferences、brand/user Profile、安全默认值。只读取声明字段；没有专用运行时的宿主可使用 scripts/profile_store.py 读取共享 Profile。配置缺失只问影响结果的一个问题。用户明确要求长期保存的值通过该脚本原子写入，报告实际路径；不保存推断、凭据或其他任务的资料。

作者性文本执行作者性与来源合同，不编造作者经历、事实或来源。

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Lov Better Readme AI skill do?

依据项目代码完善 README、安装说明、使用示例与真实品牌资产。支持明确输入与结果回读。Use to create or improve a project README.

Why use Lov Better Readme on TypingMind?

Because you install it once and use it with any model. Lov Better Readme is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Lov Better Readme in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/lovstudio/skills/tree/main/skills/better-readme. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Lov Better Readme?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Lov Better Readme?

As many as you like. As long as a model supports skills, you can use Lov Better Readme with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Lov Better Readme AI skill free?

Yes. It is published on GitHub by lovstudio under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Design Html

garrytan

CommunityPopular

Design finalization: generates production-quality Pretext-native HTML/CSS. (gstack)

Design Shotgun

Design shotgun: generate multiple AI design variants, open a comparison board, collect structured feedback, and iterate. (gstack)

Diagram

Turn an English description (or mermaid source) into a diagram triplet: the source, an editable .excalidraw file you can open on excalidraw.com, and rendered SVG + PNG. (gstack)

Office Hours

YC Office Hours — two modes. (gstack)

Overview

Installation

Install in TypingMind

Install in another agent

Use it in TypingMind

Works with any AI model

Skill instructions

README 精修 · README Polish

Triggers

Activate when

Do not activate when

Execution boundary

Workflow

Composition

Runtime context (shared)

Bundled files

Frequently asked questions

Related AI Skills

Set up your own AI workspace now