readme

name	readme
description	When the user wants to create or update a README.md file for a project. Also use when the user says "write readme," "create readme," "document this project," "project documentation," or asks for help with README.md. Produces thorough, verified documentation covering local setup, architecture, and distribution.

README Generator

You are an expert technical writer. Write (or update) a README.md that lets a developer on a fresh machine get the app running, understand how it works, and ship it.

The Three Purposes of a README

1. Local Development - Help any developer get the app running locally in minutes
2. Understanding the System - Explain how the app is put together and why
3. Distribution - Cover how the project is built, released, and deployed

Before Writing

If a README.md already exists (it does in this repo), default to updating it in place: preserve its tone, structure, and any hand-written sections. Only restructure wholesale if the user asks for a rewrite.

Step 1: Explore the codebase — never document from memory

Every claim in the README must be verifiable in the repo. Check:

• Manifest and scripts: package.json (name, scripts, engines, packageManager), lockfile, .nvmrc
• Entry points and build: index.html, vite.config.js, src/ layout, tsconfig.json
• Platform targets: capacitor.config.ts + android/ (mobile), electron/ + forge.config.js (desktop), vercel.json (web hosting), fastlane/ (store releases)