Name: Create a README file
Author: Skills Guide Bot

Automated summary

Writes a comprehensive, well-structured README.md for a project, drawing on several example open source READMEs for structure and tone.

Strengths

Enforces a proven structure by referencing four sample READMEs (Azure Samples, sinedied)
Explicit style rules: GFM, GitHub admonition syntax, restrained emoji use, and concision
Requires reviewing the whole project first and reuses an existing logo or icon in the header
Deliberately skips LICENSE, CONTRIBUTING and CHANGELOG sections, which have their own files

Limitations

Quality depends on network access to the referenced README URLs
On a large monorepo, reviewing the entire workspace may exceed the context window
Generated content is not validated: commands and badges may be inaccurate

When to use it

Use it when a project has no README, or an outdated one, and you need a standard, polished entry-point document.

When not to use it

Avoid it if you need deep API reference docs, a contribution guide or a changelog, which this skill explicitly excludes.

Security analysis

Safe

Quality score82/100

The skill only instructs generating a README based on project review and reference URLs; no destructive, exfiltration, or obfuscated actions are present, and no tools are declared.

No concerns found

How this analysis is made

Examples

New README from scratch

Review this entire project and write a README.md for it. Follow the structure and tone of the Azure Samples READMEs, keep it concise, use GFM with GitHub admonitions, and don't add LICENSE or CONTRIBUTING sections.

Refresh an outdated README

Our README is two years old and doesn't match the code anymore. Go through the workspace and rewrite README.md: header with the project logo, short description, install and usage, and no emoji overload.

Open source polish

Turn this repo into something presentable for open source: create a README.md with a logo header, a one-paragraph pitch, quickstart commands, and a couple of GitHub admonition callouts — but skip LICENSE and CHANGELOG.

name: create-readme description: 'Create a README.md file for the project'

Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

Task

Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
Take inspiration from these readme files for the structure, tone and content:
- https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md
- https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md
Do not overuse emojis, and keep the readme concise and to the point.
Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
If you find a logo or icon for the project, use it in the readme's header.

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/create-a-readme-file-ms1aw6f4' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/create-a-readme-file-ms1aw6f4/download' --output '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md.part' && mv '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md.part' '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code

test -f '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md' && test -s '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/create-readme' && cp -R '.skill-downloads/create-a-readme-file-ms1aw6f4' '.claude/skills/create-readme'

Cursor

test -f '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md' && test -s '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/create-readme' && cp -R '.skill-downloads/create-a-readme-file-ms1aw6f4' '.cursor/skills/create-readme'

Codex

test -f '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md' && test -s '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/create-readme' && cp -R '.skill-downloads/create-a-readme-file-ms1aw6f4' '.agents/skills/create-readme'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation

openskills install './.skill-downloads/create-a-readme-file-ms1aw6f4'

openskills read 'create-a-readme-file-ms1aw6f4'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Supabase Docs Authoring

Documentation

Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.

Claude CodeintermediateSafe 108,544

Skills Guide Bot