Skip to content

Create polished demo videos without editing skills. Mac/Windows/Linux

docs: clean up contributor guidance files

webadderallc5d8038c4c7d
diff --git a/- b/-
deleted file mode 100644
index 8b137891..00000000
--- a/-
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/0 b/0
deleted file mode 100644
index 8b137891..00000000
--- a/0
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/CLAUDE.md b/CLAUDE.md
deleted file mode 100644
index 2080d1ea..00000000
--- a/CLAUDE.md
+++ /dev/null
@@ -1,85 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## Commands
-
-| Command | Description |
-|---------|-------------|
-| `npm run dev` | Start Vite dev server + Electron |
-| `npm run build` | Full production build (native helpers → TypeScript → Vite → Electron Builder) |
-| `npm run build:win` | Windows build (includes native DXGI capture) |
-| `npm run build:mac` | macOS build |
-| `npm run build:linux` | Linux build |
-| `npm run lint` | Biome lint check |
-| `npm run lint:fix` | Biome auto-fix |
-| `npm run format` | Biome format |
-| `npm run test` | Run Vitest (single run) |
-| `npm run test:watch` | Vitest in watch mode |
-| `npm run i18n:check` | Validate i18n locale file structure against `en` |
-
-Run a single test file: `npx vitest run src/lib/exporter/gifExporter.test.ts`
-
-## Architecture
-
-**Electron + React + Vite** desktop screen recorder and video editor.
-
-### Process Model
-
-- **Main process** (`electron/main.ts`): Window lifecycle, tray icon, native recording, file I/O, permissions, auto-cleanup
-- **Preload** (`electron/preload.ts`): contextBridge API exposing ~40 IPC methods to renderer
-- **IPC handlers** (`electron/ipc/handlers.ts`): All main↔renderer communication; recording pipelines, file operations, project persistence, shortcuts, cursor telemetry
-- **Renderer** (`src/`): React SPA routed by `?windowType=` URL parameter (no router library)
-
-### Three Window Types
-
-1. **HUD Overlay** (`?windowType=hud-overlay`): 500×155 floating bar at screen bottom for recording controls. Transparent, always-on-top.
-2. **Editor** (`?windowType=editor`): Main video editor window (1200×800, maximized). Houses timeline, playback, annotations, export.
-3. **Source Selector** (`?windowType=source-selector`): 620×420 popup for picking capture sources.
-
-`App.tsx` switches components based on the `windowType` query param.
-
-### Recording Pipeline (Platform-Specific)
-
-- **macOS**: ScreenCaptureKit via compiled Swift helpers (`scripts/build-native-helpers.mjs`)
-- **Windows**: DXGI Desktop Duplication via C++ CMake build (`scripts/build-windows-capture.mjs`), fallback to FFmpeg
-- **Linux**: Chromium `getDisplayMedia`
-- Core recording logic: `src/hooks/useScreenRecorder.ts` (60 FPS target, adaptive bitrate)
-
-### Export Engine (`src/lib/exporter/`)
-
-GPU-accelerated pipeline: WebCodec streaming decode → PIXI.js frame rendering (zoom, crop, annotations, cursor) → MP4 mux (mp4box) or GIF (gif.js with Web Workers). Key files: `videoExporter.ts`, `gifExporter.ts`, `frameRenderer.ts`, `streamingDecoder.ts`, `muxer.ts`.
-
-### State Management
-
-No external state library. `VideoEditor.tsx` uses ~50 `useState` hooks. Undo/redo via `useRef` history stacks. Only two React Contexts: `I18nContext` and `ShortcutsContext`.
-
-### i18n System
-
-- Config: `src/i18n/config.ts` — languages: `en` (source), `es`
-- Locale files: `src/i18n/locales/{lang}/{namespace}.json`
-- 7 namespaces: `common`, `launch`, `editor`, `timeline`, `settings`, `dialogs`, `shortcuts`
-- Implementation: `src/contexts/I18nContext.tsx` — compile-time JSON import, recursive key lookup, `{{var}}` interpolation
-- Fallback chain: current language → English → provided fallback → raw key
-- Run `npm run i18n:check` after any locale changes
-- See `TRANSLATION_GUIDE.md` for contributor workflow
-
-### UI Layer
-
-- Base components: `src/components/ui/` — Radix UI primitives wrapped with shadcn/ui patterns
-- Styling: Tailwind CSS with CSS variable theming, class-based dark mode
-- Icons: lucide-react + react-icons
-- Timeline: `dnd-timeline` library for drag-and-drop editing
-- Path alias: `@/` → `src/`
-
-### Project File Format
-
-`.recordly` files (legacy `.openscreen` supported). Serialization in `src/components/video-editor/projectPersistence.ts`.
-
-## Code Quality
-
-- **Biome** is the primary linter/formatter (tab indent, LF, 100 char width)
-- **Strict TypeScript**: `noExplicitAny: error`, no unused variables/params
-- **Hook rules enforced**: `useHookAtTopLevel: error`
-- **Import organization**: automatic via Biome
-- Tests use Vitest + fast-check (property-based testing). Test files: `src/**/*.{test,spec}.{ts,tsx}`
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d386d2ff..b3274784 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,8 +5,7 @@ Thank you for considering contributing to this project! By contributing, you hel
Areas where help is especially valuable:
- Native screen recording for Linux
-- **Webcam overlay bubble**
-- **UI/UX design improvements (very helpful)**
+- UI/UX design improvements
- German localisation
- Code optimisation/refactoring
- Auto-zoom suggestion logic improvements
diff --git a/TRANSLATION_GUIDE.md b/TRANSLATION_GUIDE.md
index ef494308..b0b599d7 100644
--- a/TRANSLATION_GUIDE.md
+++ b/TRANSLATION_GUIDE.md
@@ -8,6 +8,7 @@ All locale files live under:
- `src/i18n/locales/en/`
- `src/i18n/locales/es/`
+- `src/i18n/locales/zh-CN/`
Each locale has the same namespace files: