Deep Research Read Me

Shape a GitHub OSS README so readers quickly understand what the project does and how to start using it.

Workflow

1. Confirm the context.

   • Identify the project type: library, CLI, web app, or GitHub Action.
   • Identify the target reader: user, evaluator, or contributor.
   • Identify the README goal: create, improve, or review.

2. Build the first view.

   • Put the project name in the H1.
   • State the value in one or two sentences before explaining the technology stack.
   • Provide the shortest path to Quickstart.
   • Include only essential links, such as Docs, Issues, and Releases.