README.md template for AI coding projects

What it is, how to run it, how to check it.

Download README.md

How to use this template

  1. Read the template. Inspect the full file below and decide which instructions match your project.
  2. Adapt it to your repo. Save it as README.md. Replace placeholders and update stack choices, paths and verification commands to match your repository.
  3. Check and commit. Review the diff. Test the listed commands and keep the file in version control so future changes can be reviewed.

Complete template

# [App name]

One sentence on what the app does and who it is for.

## Run it

```bash
npm install
npx expo start
```

Scan the QR code with your phone.

## Check it

```bash
npx tsc --noEmit
npm test
```

## Stack

See docs/TechDesign.md. The agent's rules are in AGENTS.md.

## License

MIT