readme-writing SKILL.md skillA

readme-writing from higoralves/orc is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned

mdr add higoralves/orc/readme-writing@git:20261020.7a1f356

Pins git:20261020.7a1f356 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: higoralves/orc
Path: orc/skills/readme-writing/SKILL.md
Versions recorded: 2
Latest version: git:20261020.7a1f356, committed Oct 20, 2026
First version recorded: Aug 5, 2026
Size: 1,477 bytes
Repository stars: 7
License: MIT

Create a comprehensive, well-structured README.md for the current project by reviewing the entire codebase first.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

## Role

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

## Task

1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
2. 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
3. Do not overuse emojis, and keep the readme concise and to the point.
4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add higoralves/orc/readme-writing@sha256:fd5be192eba7457a

The line at the top of this page pins the label git:20261020.7a1f356, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

[![mdr](https://markdownregistry.com/badge/art_pxha6bcgpzjlenvr.svg)](https://markdownregistry.com/a/art_pxha6bcgpzjlenvr)

2 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 2 versions of this file, between Aug 5, 2026 and Oct 20, 2026, about one every 76 days.

version	committed	commit	size	audit
git:20261020.7a1f356 latest	2026-10-20	7a1f356	1,477 B	A	view · diff
git:20260805.600ee50	2026-08-05	600ee50	1,486 B	A	view

Audit of the latest version

A 17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.

pass: Frontmatter block present
pass: Frontmatter declares a name
pass: Frontmatter declares a description
pass: Size between 200 bytes and 200 KB (1477 bytes)
pass: No zero-width or bidi control characters
pass: No instruction hidden inside an HTML comment
pass: No link to an exfiltration or paste host
pass: No credential-shaped string
pass: No instruction to send local credentials anywhere
pass: No text hidden with inline styles
pass: No prompt-injection phrasing
pass: No curl or wget piped into a shell
pass: No recursive delete of root, home or parent
pass: No instruction to read or print local credentials
pass: No base64 blob over 200 characters
pass: No link to a raw IP address
pass: No script tag

Source

GitHub

higoralves/orc · 7 stars · license MIT · pushed 2026-11-06 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_pxha6bcgpzjlenvr
GET https://markdownregistry.com/api/v1/resolve?ref=higoralves/orc/readme-writing
GET https://markdownregistry.com/api/v1/blob/fd5be192eba7457a7e1711e0f88f2b7a1abb81bd5a0b85b78a54751035f106de

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.