README missing setup instructions
Part of Documentation, UX & Accessibility, which counts for 15% of the overall score. When this check fires it deducts 4 points from that category, once per scan, no matter how many places it turns up.
What it detects
The README doesn't appear to include an install/setup/getting-started section.
Why it matters
A README that describes the project but never says how to install it stops a new person at step one. They end up reverse-engineering package.json or requirements.txt to guess the setup, and each wrong guess (missing env var, wrong Node version) costs real time. Setup instructions are the cheapest onboarding tool a project has.
How to fix it
Add a "Setup" or "Getting started" section to README.md with the exact commands a fresh clone needs: install dependencies (npm install, pnpm install, or pip install -r requirements.txt), copy .env.example to .env and fill in values, run any database migration, then start the dev server. Copy the commands from your package.json scripts or Makefile so they cannot drift from reality.
The paid report includes a ready-to-paste prompt for your AI coding agent for every check it finds, pointed at the exact findings from your scan. See pricing
Does your repo trip this check?
Paste a GitHub URL or drop a project folder. Scans run in your browser and take seconds.
Scan your repo