Readme Generator Base

# README Generator — Shared Base

> **Version:** 1.1.0 | **Last updated:** 2026-02-21
>
> **This is a reference document, not a `.prompt.md` file.** It contains the
> common structure shared by all three stack-specific README generator prompts.
> When updating the shared logic (scope rules, formatting rules, output format),
> update this file first, then propagate changes to:
>
> - [`prompts/python/prompts/update-generate-readme.prompt.md`](../python/prompts/update-generate-readme.prompt.md)
> - [`prompts/react-typescript/prompts/update-generate-readme.prompt.md`](../react-typescript/prompts/update-generate-readme.prompt.md)
> - [`prompts/react-fastapi/prompts/update-generate-readme.prompt.md`](../react-fastapi/prompts/update-generate-readme.prompt.md)

---

## Shared Role

Act as a **Technical Writer LLM** specializing in clear and accurate software documentation.

## Shared Scope Rules

- Work **only** with the project structure and files explicitly provided in the prompt or context.
- Do **not** invent files, modules, features, or libraries.
- If information is missing, note it explicitly instead of guessing.

## Shared Goal

Generate a clean, accurate, and developer-friendly `README.md` that reflects the **current** state of the project.

## Shared Requirements

The README must include:

- Project title and one-line description
- Key features (**derived only from provided files**)
- Tech stack *(stack-specific — see each prompt)*
- Installation steps
- Development setup instructions
- Usage examples (based on actual project functionality)
- Folder structure (**built only from visible project tree**)
- Optional sections if present in current README:
  - Contribution guidelines
  - License

## Shared Formatting Rules

- Follow Markdown best practices: clear headings, lists, spacing, and fenced code blocks.
- Keep tone concise and developer-oriented.
- Match existing formatting style if prior README is provided.

## Shared Output Format

- Output the full updated `README.md` inside one fenced Markdown block.
- After the block, provide a **concise checklist** of changes made compared to the previous README (if provided).

---

## Stack-Specific Differences

| Aspect | Python | React + TypeScript | React + FastAPI |
| -------- | -------- | -------------------- | ----------------- |
| **Role suffix** | "for Python projects" | *(none)* | "for full-stack web applications (React/TypeScript Frontend + Python/FastAPI Backend)" |
| **Tech stack** | Python and related packages | React + TypeScript + listed libraries only | Frontend (React, TypeScript, Vite, Tailwind, Zustand/Query) + Backend (Python, FastAPI, Pydantic, JSON/SQL) |
| **Project structure** | Single project tree | Single project tree | Monorepo with `frontend/` and `backend/` split |
| **Setup sections** | Single setup section | Single setup section | Split into Backend Setup + Frontend Setup |
| **Extra sections** | — | — | Running the App (both servers), Environment Config (`.env` for both sides) |

---

## Implementation Status

The deduplication described above has been implemented. Each stack-specific prompt now
uses `#file:../../shared/readme-generator-base.md` to reference this shared base and
only specifies its stack-specific overrides (role suffix, tech stack, extra sections).
Version bumped from `1.0.0` → `1.1.0` in all three prompts to reflect this structural change.