Add README with design principle, TASKS.md roadmap, and ai.md agent guide

2026-08-04 10:24:20 -07:00
parent b3c81f0af8
commit 8aebbff318
3 changed files with 184 additions and 0 deletions
@@ -0,0 +1,42 @@
+# ytLive
+
+A creator-proof live-streaming and recording app for YouTube — native Windows (C# / WPF / .NET 8).
+
+## Design Principle
+
+> This software is so intuitive that even the most right-brained person can easily intuit and use it.
+
+Every feature is measured against this. One-click go-live, sane YouTube defaults, visual scene
+building, and no dead ends — every action has a visible outcome.
+
+## Why ytLive
+
+OBS treats YouTube as an afterthought; SLOBS is Twitch-first with YouTube bolted on. ytLive is
+designed and dedicated to YouTube livestreaming and recording, and to YouTube's specific quirks.
+
+## Run
+
+```bash
+dotnet build   # Windows only — WPF
+dotnet run
+```
+
+## Version Roadmap
+
+| Version | Scope |
+|---------|-------|
+| v0.1     | Scene/source management, YouTube RTMP ingest, YouTube OAuth2, live chat, stream health |
+| v0.2     | Recording to local file |
+| v0.3     | Stream scheduling |
+| v0.4     | Multi-destination restreaming |
+| 1.0      | General availability |
+
+## Structure
+
+| Path | Role |
+|------|------|
+| `Models/` | Scene, Source, StreamConfig, StreamHealth, YouTube channel/chat |
+| `ViewModels/` | MainViewModel — scenes, stream controls, chat |
+| `Services/` | YouTubeAuthService (OAuth2), YouTubeStreamService (broadcast/health), YouTubeChatService (chat polling) |
+| `Helpers/` | ViewModelBase, RelayCommand |
+| `MainWindow.xaml` | Dark-theme main UI: scene/source panel, preview, chat, status bar |