3.1 KiB
3.1 KiB
AI Blueprint: Update README.md
Version: 1.0.1
System Rules: AI Blueprint Execution Protocol
CRITICAL: Every time an AI reads or uses this blueprint to perform a task, it MUST adhere to the following strict protocol before finishing:
- Increment Version: The AI must update the
**Version:**number at the top of this file. Use Semantic Versioning (e.g., from1.0.0to1.0.1for task updates). - Auto-Commit: The AI must automatically create a git commit encapsulating all changes made during the session.
- Commit Message: The commit message must include the new version number and a summary of the task performed (e.g.,
git commit -am "Blueprint v1.0.1: Completed README update").
Objective
Update the existing README.md to accurately reflect the newly refactored modular architecture of the BookApp project, while strictly minimizing the context window required for the AI (Claude).
Context to Provide to Claude
Do NOT feed Claude the entire codebase. Only provide the following context to Claude in your prompt:
- The contents of the current
README.md. - The new directory structure (provided below).
- A brief summary of the refactoring (provided below).
New Directory Structure
BookApp/
├── ai/ # AI model integrations and setup
├── cli/ # Command-line interface and wizard engine
├── core/ # Core configuration and shared utilities
├── export/ # Book exporting logic (e.g., EPUB, PDF)
├── marketing/ # Marketing assets, blurb, and cover generation
├── story/ # Story generation, planning, writing, and bible tracking
├── templates/ # HTML templates for the web application
├── web/ # Flask/FastAPI web application, routes, tasks, and DB
├── docker-compose.yml
├── Dockerfile
├── requirements.txt
└── README.md
Summary of Refactoring
- The application was heavily refactored from monolithic scripts into a clean, modular package structure with distinct separation of concerns.
web/handles all UI, routing, and background tasks.story/handles the core AI writing pipeline.marketing/handles post-generation assets.cli/handles terminal-based execution (wizard).
Steps for Claude to Execute
Provide Claude with this exact list of steps:
- Analyze: Read the provided current
README.mdand the new directory structure. - Update Architecture/Structure: Completely rewrite the "Project Structure" or "Architecture" section of the README to map to the new directories (
ai/,cli/,core/,export/,marketing/,story/,web/). - Update Features: Update the feature descriptions to reflect the distinct modules (e.g., separating Web UI features from CLI Wizard features, Story generation from Marketing assets).
- Update Instructions: Ensure the setup and running instructions (Docker or local) remain accurate. Note that web dependencies are in
web/requirements_web.txtand core dependencies inrequirements.txt. - Format: Output the entirely updated
README.mdin clean Markdown. Ensure it is professional, concise, and well-organized.