deepresearch-readme

Deepresearch Readme

Prepare a README for GitHub OSS so that it conveys "what it can do" and "how to start" in a short time.

Approach

1. Determine the prerequisites.

• Identify the project type: library / CLI / web app / GitHub Action
• Identify the target audience: users / evaluators / contributors
• Determine the purpose of the README: new creation / improvement / review

1. Structure the first view.

• Write the project name in H1
• Write the value in 1–2 sentences (present the value before explaining the tech stack)
• Place the shortest path to Quickstart
• Place only the necessary main links (Docs, Issues, Releases)

1. Make the Quickstart as short as possible.

• Requirements、Install、Run Keep it to about 3–6 lines in the order of
• Keep only commands that can actually be executed
• If OS differences become long, docs/installation.md separate it into

1. Finish the structure.

• The basic sections are as follows:
• Highlights
• Quickstart
• Usage
• Documentation
• Getting help
• Contributing
• License
• Cut out detailed explanations into docs/ and leave only relative links in the README

1. Perform final verification.

• Check whether one can reach "installation → minimal execution" within 5 minutes
• Check for broken links, prerequisite versions, and outdated procedures
• references/readme-review-checklist.md Check coverage with

Output template

When creating the README body, references/readme-template.md prefer to use the template of

Review policy

When reviewing an existing README, prioritize the following.

1. Critical

• Quickstart cannot be executed
• Required information (What/How to start/Help) is missing
• The README has become huge, and the getting-started steps are buried

1. Warning

• The section order is misaligned with the reader's decision-making order
• The pathway to docs is weak
• There are too many badges and links, making the value hard to convey

1. Info

• Simplify expressions
• Add examples (CLI execution examples, minimal code examples)
• Add pathways to FAQ and troubleshooting

Reference files

• Practical checklist: references/readme-review-checklist.md
• README template: references/readme-template.md