setup-install-usage-docs

Installation
SKILL.md

Setup, install, and usage docs

Goal

Write content-supported docs for:

  • docs/INSTALL.md: setup steps, dependencies, environment requirements.
  • docs/USAGE.md: how to run the tool, CLI flags, practical examples.

Write a doc when repo evidence supports a real Requirements/Install section (INSTALL) or a real Quick-start/CLI section (USAGE). Treat a basic runnable command, an entry point, or a dependency manifest (pip_requirements.txt, pyproject.toml, Brewfile) as install or usage evidence and write the doc from it; INSTALL and USAGE are near-universal, so do not skip them when this evidence exists. Report the gap instead of writing a file only when no such evidence exists, so the only content would be a title plus "Known gaps".

Inputs to request

Installs
1
GitHub Stars
5
First Seen
Jul 30, 2026