agentsclimarketplace
Sign in

Write github readme

Skill workingclassbuddha/codexmaxxing/skills/write-github-readme

Create or improve GitHub-ready README files and repository landing docs. Use when Codex needs to package a project for readers with a clear purpose, quick start, screenshots, examples, install/run/test commands, project structure, safety notes, contribution notes, or private/public publishing context.From its SKILL.md

Install
npx -y skills add workingclassbuddha/codexmaxxing --skill write-github-readme

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

1.3 KB, 201 tokens by cl100k_base, as published. Nobody here has run it

Write GitHub README

Use this skill to turn a local artifact into something another person can understand, run, and evaluate from GitHub.

Workflow

  1. Read the repo shape: files, scripts, tests, screenshots, examples, and current README.
  2. Identify the audience: future self, collaborator, recruiter, OSS reader, customer, or private team.
  3. Put the value and runnable path above the fold.
  4. Include exact commands that were verified, not aspirational commands.
  5. Add screenshots or example images when visual output matters.
  6. Add limitations and safety notes when the repo is private, experimental, or local-only.

README Shape

  • Project name and one-line purpose.
  • Short visual or artifact preview.
  • What it does.
  • Quick start.
  • Examples or screenshots.
  • Project structure.
  • Test/verification commands.
  • Privacy/safety notes.
  • Roadmap or next steps.

Read references/readme-template.md for a concise template.

What ships with it: 2 files

946 B alongside SKILL.md

agents/

references/

Keep looking

Skills are one crate of 325,949. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.