dicklesworthstone/meta_skill
Overview
This skill crafts professional README.md files tuned for open source projects, with a focus on Rust CLIs such as tools for managing Claude Code skills. It generates a complete structure: hero section, TL;DR, quick examples, installation options, command reference, architecture diagrams, troubleshooting and honest limitations. The output is copy-paste ready and optimized for clarity, conversion, and developer onboarding.
How this skill works
Provide the current README or a brief project summary and the tool will rewrite or generate a README following a proven, scannable structure. It builds a hero area with badges and a curl one-liner, a TL;DR that sells value, concrete examples (5–10 commands), comparison tables, full command reference, and an ASCII architecture diagram. Every feature claim is paired with a concrete example and install paths include curl, package manager, and from-source instructions.
When to use it
- Creating a new README for a Rust CLI (especially tools for indexing/building/bundling skills).
- Revising a README that buries value under installation or lacks examples.
- Documenting a CLI tool, library, or open source project prior to release.
- Preparing a README to include CI/license badges, quick install, and comparison tables.
- Adding an architecture diagram and troubleshooting section for complex tooling.
Best practices
- Lead with TL;DR before installation so scanners see value first.
- Include a curl one-liner above the fold as an escape hatch for impatient users.
- Show concrete examples for every claimed feature (copy-paste commands).
- Provide at least three installation paths: quick script, package manager, from source.
- Add an ASCII architecture diagram for data flow and a concise troubleshooting list.
- Be honest about limitations and list workarounds where possible.
Example use cases
- Generate a README for a Rust CLI that indexes coding sessions into reusable skills.
- Revise an existing README to add a hero section, badges, and a curl installer.
- Create a command reference and config file example for a CLI with multiple commands.
- Produce a comparison table vs alternatives to clarify when to use the tool.
- Add an architecture ASCII diagram showing indexing → processing → storage → output.
FAQ
Yes. Every feature claim is paired with a runnable command or config snippet that users can copy and run.
Will this produce installation scripts or just documentation?
It produces documentation with a recommended curl installer and clear instructions for package managers and building from source, but not signed distribution artifacts.
Does it handle project-specific badges and links?
Yes. Provide the CI, license and release URLs or let the skill insert badge placeholders you can replace with real links.
4 skills
This skill helps you craft professional README.md files for GitHub projects, including hero sections, installation guides, and architecture diagrams.
This skill guides Rust developers through error handling, testing, and logging patterns, demonstrated via includes composition and practical CLI examples.
This skill guides implementing foundational testing patterns to ensure deterministic, well-scoped tests across happy paths, error cases, and edge conditions.
This skill guides explicit, contextual error handling to improve clarity, observability, and reliability across applications.
