Restore README.md from commit 2c08fce

README.md

@@ -1,46 +1,84 @@
-# 🎯 LCS Video Pipeline Wiki
+# 🎬 LCS Pipeline
 
-Welcome to the **LCS Video Pipeline Wiki** — the central knowledge base for the entire project.  
-This wiki covers setup, workflows, troubleshooting, and developer documentation for the **Llama Chile Shop** video automation pipeline.
+**Automated livestream highlight rendering and publishing for Fortnite content featuring Gramps.**
+
+This project powers the backend of [Llama Chile Shop](https://www.youtube.com/@llamachileshop), transforming raw livestream clips into polished, uploaded videos — complete with titles, thumbnails, intros/outros, and social metadata.
 
 ---
 
-## 📚 Table of Contents
+## ⚙️ Features
 
-- [Getting Started](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Getting-Started)
-- [System Requirements](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/System-Requirements)
-- [Project Structure](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Project-Structure)
-- [Automation Workflow](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Automation-Workflow)
-- [Rendering Engine](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Rendering-Engine)
-- [Social Posting](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Social-Posting)
-- [Troubleshooting](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Troubleshooting)
-- [Changelog](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Changelog)
+* ✅ Daily folder scan for new stream sessions
+* 🎬 Clip classification (`hits/`, `misses/`, `montages/`, etc.)
+* 🧠 AI-generated titles and descriptions via OpenAI
+* 🪄 Auto-stitched intro + title card + outro
+* 🖼️ Dynamic thumbnail creation with Fortnite styling
+* ⬆️ Uploads to YouTube (and PeerTube if enabled)
+* 🧾 Metadata archive and session history
+* 🐘 (Planned) Social posts to Mastodon and Bluesky
 
 ---
 
-## 🗂 Site Index
+## 🚀 Quick Start
 
-| Page | Description |
-|------|-------------|
-| [Home](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Home) | Overview & quick links |
-| [Getting Started](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Getting-Started) | Install & configure your environment |
-| [System Requirements](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/System-Requirements) | Hardware & software prerequisites |
-| [Project Structure](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Project-Structure) | Folder layout & file descriptions |
-| [Automation Workflow](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Automation-Workflow) | End-to-end processing flow |
-| [Rendering Engine](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Rendering-Engine) | Video editing & rendering details |
-| [Social Posting](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Social-Posting) | YouTube, PeerTube, Mastodon, Bluesky |
-| [Troubleshooting](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Troubleshooting) | Common problems & fixes |
-| [Changelog](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Changelog) | Version history |
+```bash
+git clone https://github.com/LCS-Gramps/video-pipeline.git
+cd video-pipeline
+pip install -r requirements.txt
+cp .env.example .env  # Fill in your API keys and config
+python main.py
+```
+
+> Requires Python 3.13+ and access to mapped NAS directory (e.g. `Z:\2025.08.05\hits\`).
 
 ---
 
-## 💡 About This Project
+## 🗂️ Folder Structure
 
-The **LCS Video Pipeline** automates the entire process of turning livestream footage into polished highlight videos — complete with intros, outros, titles, and metadata — then uploads them to social platforms with dynamic descriptions and hashtags.
-
-This wiki is the **source of truth** for all documentation.  
-If something is unclear, out of date, or missing — update it here first.
+```
+video-pipeline/
+├── main.py
+├── config.py
+├── .env.example
+├── modules/
+│   ├── render_engine.py
+│   ├── title_utils.py
+│   ├── thumbnail_utils.py
+│   ├── yt_poster.py
+│   └── ...
+├── assets/         # Branding assets (intros, fonts, logos)
+├── logs/           # Sync logs, wiki publish logs, etc.
+└── metadata/
+    └── history/    # Per-clip metadata archive
+```
 
 ---
 
-> 📝 **Tip:** Each wiki page automatically displays a Table of Contents on the right-hand side. Use it to jump quickly between sections.
+## 📚 Documentation
+
+Full documentation is hosted in the GitHub Wiki:
+👉 [📖 LCS Pipeline Wiki](https://github.com/LCS-Gramps/video-pipeline/wiki)
+
+Recommended pages:
+
+* [`Home`](https://github.com/LCS-Gramps/video-pipeline/wiki)
+* [`Clip Handling Logic`](https://github.com/LCS-Gramps/video-pipeline/wiki/Clip-Handling-Logic)
+* [`Metadata Extraction`](https://github.com/LCS-Gramps/video-pipeline/wiki/Metadata-Extraction)
+* [`YouTube Upload Logic`](https://github.com/LCS-Gramps/video-pipeline/wiki/YouTube-Upload-Logic)
+
+---
+
+## 🧪 Development Mode
+
+* `DEBUG=True` in `.env` disables destructive operations
+* All modules can be run/tested independently
+* Wiki editing is supported via local Markdown and `wiki_publish.log`
+
+---
+
+## 🧙 About
+
+Created by **Gramps** for Llama Chile Shop — a custom content pipeline for old-school gaming chaos.
+
+> Maintainer: `gramps@llamachile.shop`
+> Contributions welcome in the form of bug reports, pull requests, or Fortnite gifts. 🎁