Skip to content
Agentmart
Submit a tool

readme

Generate or update README.md from the actual codebase.

Skill by lunitrixx

IndexedMIT
Write a review

Chalk Labs

Need help deploying readme?

Chalk Labs sets up agents like this inside real teams: connected to your tools, tested on your data, with a human in the loop where it matters.

Book a call

Install

Works with Claude Code, Claude apps, Codex, Cursor, Gemini CLI, GitHub Copilot, VS Code, OpenCode, Goose, Windsurf. Read the repository before you give any tool access to your data.

npx agentmarket install skill/lunitrixx-readme

Asks which of your tools to add it to (Claude Code, Codex, Cursor, VS Code, Windsurf, Gemini CLI, Claude Desktop) and shows the change first. See https://agentmart.dev/cli.

Get the weekly diff

The weekly diff: one email a week with new agent tools, notable updates and grade changes, plus security alerts for tools you follow. Double opt-in, one-click unsubscribe.

We use your email only for this newsletter. Privacy

About

Generate or update README.md from the actual codebase. Use for "write a README", "update the README", "document the project", "make a readme for this".

Use cases: documents, writing

No reviews yet. Installed it? Reviews come from verified installers only. How reviews work

Permissions

What this skill can do and what it asks for, from its SKILL.md. Checked Oct 25, 2026.

Tools
No tools found
Secrets
None asked for
Install scripts
None found

Network hosts it talks to 1

  • codeload.github.com · found in install command

Files it touches

  • ~/.claude/skills/readme

What's inside

Skill name
readme
Description
Generate or update README.md from the actual codebase. Use for "write a README", "update the README", "document the project", "make a readme for this".
License
MIT
Instructions
25 lines in SKILL.md · view on GitHub

Files (1)

  • SKILL.md

SKILL.md (first lines)

# README

1. Read manifests (`package.json`, `pyproject.toml`, `go.mod`, ...), entry points, exported APIs, CLI commands. Never guess or template-fill.
2. Read the existing README. Keep every hand-written section; only add what is missing.
3. Fill this structure:

```markdown
# <Name>
<one-line description>
<badges: license, version, and the stack's own (shields.io npm/pypi/crates/go-mod, CI workflow badge)>

## Quick Start      clone, install, run
## Usage            real, copy-pasteable examples
## Architecture     ASCII or Mermaid: components and data flow
## API Reference    link to docs/source or the key exports
## Development      install dev deps, test, build
## Contributing     short; link CONTRIBUTING.md if it exists
## License          <name> - see [LICENSE](LICENSE)
```

4. Run every command in the README; if one fails, fix the README.

Scannable: short paragraphs, code blocks. One README unless the project already uses multi-doc. Link instead of duplicating.

From lunitrixx/pi-agent-kit, MIT.

More from lunitrixx/pi-agent-kit

Signals

Stars
0
Forks
0
Open issues
0
Last commit (this folder)
Oct 16, 2026 (16 days ago)

From GitHub (fetched Oct 24, 2026).

Details

License
MIT
First seen
Oct 24, 2026
Last checked
Oct 24, 2026

More from lunitrixx

Done for you

Rather not set it up yourself?

Chalk Labs scopes, builds and runs agents for your team: the task audit, the eval harness, the integrations and the weekly ops report. Fixed scope, priced before we start.

See how we build AI agents →Read the case studies

Chalk Labs is a two-founder AI and growth studio. We build AI agents, CRMs and MVPs for Web3 and AI companies, and have shipped 50+ product and token launches.

launches shipped
50+
launches shipped
media placements
500+
media placements
founders on every account
2
founders on every account

Press we've placed: Forbes · CoinDesk · Decrypt · Cointelegraph · The Block

Rahil Jain, Co-founder, Chalk Labs. Ex-Goldman Sachs engineer. You talk to the person who builds it.

Get readme running in your business

Tell us what you want to automate. A founder replies within one working day with a plan, not a pitch deck.

Goes to the Chalk Labs founders, not the newsletter. Privacy

Need help deploying readme?

CallGet help
Cite this page

readme skill. Agent Mart. https://agentmart.dev/skills/lunitrixx-readme (last updated 2026-10-24)