The open-source CapCut alternative
docs: refocus readme on rewrite
Maze Winther238750c02506
diff --git a/README.md b/README.mdindex af46df56..c56d5d73 100644--- a/README.md+++ b/README.md@@ -1,167 +1,44 @@<table width="100%"><tr><td align="left" width="120">- <img src="apps/web/public/logos/opencut/icon.svg" alt="OpenCut Logo" width="100" />+ <img src="https://assets.opencut.app/branding/symbol.svg" alt="OpenCut Logo" width="100" /></td><td align="right"><h1>OpenCut</h1>- <h3 style="margin-top: -10px;">A free, open-source video editor for web, desktop, and mobile.</h3>+ <h3 style="margin-top: -10px;">A free and open source video editor for web, desktop, and mobile.</h3></td></tr></table>-## Sponsors--Thanks to [Vercel](https://vercel.com?utm_source=github-opencut&utm_campaign=oss) and [fal.ai](https://fal.ai?utm_source=github-opencut&utm_campaign=oss) for their support of open-source software.--<a href="https://vercel.com/oss">- <img alt="Vercel OSS Program" src="https://vercel.com/oss/program-badge.svg" />-</a>--<a href="https://fal.ai">- <img alt="Powered by fal.ai" src="https://img.shields.io/badge/Powered%20by-fal.ai-000000?style=flat&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTEyIDJMMTMuMDkgOC4yNkwyMCAxMEwxMy4wOSAxNS43NEwxMiAyMkwxMC45MSAxNS43NEw0IDEwTDEwLjkxIDguMjZMMTIgMloiIGZpbGw9IndoaXRlIi8+Cjwvc3ZnPgo=" />-</a>--## Why?--- **Privacy**: Your videos stay on your device-- **Free features**: Most basic CapCut features are now paywalled-- **Simple**: People want editors that are easy to use - CapCut proved that--## Project Structure--- `apps/web/`: Next.js web application-- `apps/desktop/`: Native desktop app built with GPUI (in progress)-- `rust/`: Platform-agnostic core: GPU compositor, effects, masks, and WASM bindings. We're actively migrating business logic here from TypeScript.-- `docs/`: Architecture and subsystem documentation--## Getting Started--### Prerequisites--- [Bun](https://bun.sh/docs/installation)-- [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/)--> **Note:** Docker is optional but recommended for running the local database and Redis. If you only want to work on frontend features, you can skip it.--### Setup--1. Fork and clone the repository--2. Copy the environment file:-- ```bash- # Unix/Linux/Mac- cp apps/web/.env.example apps/web/.env.local-- # Windows PowerShell- Copy-Item apps/web/.env.example apps/web/.env.local- ```--3. Start the database and Redis:-- ```bash- docker compose up -d db redis serverless-redis-http- ```--4. Install dependencies and start the dev server:-- ```bash- bun install- bun dev:web- ```--The application will be available at [http://localhost:3000](http://localhost:3000).--The `.env.example` has sensible defaults that match the Docker Compose config — it should work out of the box.+[](https://discord.gg/zmR9N35cjK)+[](https://x.com/opencutapp)+[](LICENSE)-### Desktop setup+## Status-Desktop is opt-in. If you're only working on the web app, skip this entirely.+**OpenCut is being rewritten from the ground up.** What's coming:-If you want to get ready for `apps/desktop`, see [`apps/desktop/README.md`](apps/desktop/README.md). It's a two-step setup: Rust toolchain first, then desktop native dependencies.+- An Editor API+- First-class third party plugins (made possible by a plugin-first architecture)+- Desktop, mobile, and browser from one codebase (Rust core)+- MCP server (for AI agents)+- Headless mode (automation, batch rendering)+- A scripting tab directly in the editor-### Local WASM development+You can still find the previous version at [opencut-app/opencut-classic](https://github.com/opencut-app/opencut-classic), which is the one to reach for today. [opencut.app](https://opencut.app) still runs the classic version; the rewrite will live at [new.opencut.app](https://new.opencut.app) until it's ready to take over.-Only needed if you're editing `rust/wasm` and want the web app to use your local build instead of the published package.--**Prerequisites** — install these once before anything else:--```bash-# Rust toolchain-curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh--# build the WASM package-cargo install wasm-pack--# reruns the build on file changes, used by bun dev:wasm-cargo install cargo-watch-```--1. Build the package once from the repo root:-- ```bash- bun run build:wasm- ```--2. Register the generated package for linking:-- ```bash- cd rust/wasm/pkg- bun link- ```--3. Link `apps/web` to the local package:-- ```bash- cd apps/web- bun link opencut-wasm- ```--4. Rebuild on changes while you work:-- ```bash- bun dev:wasm- ```--To switch `apps/web` back to the published package, run:--```bash-cd apps/web-bun add opencut-wasm-```--### Self-Hosting with Docker+## Sponsors-To run everything (including a production build of the app) in Docker:+OpenCut is supported by companies that believe in open source creator tools.-```bash-docker compose up -d-```+- [**fal.ai**](https://fal.ai?utm_source=github-opencut&utm_campaign=oss): Generative image, video, and audio models all in one place.-The app will be available at [http://localhost:3100](http://localhost:3100).+Want your logo here? Reach out at [[email protected]](mailto:[email protected]).## Contributing-We welcome contributions! While we're actively developing and refactoring certain areas, there are plenty of opportunities to contribute effectively.--**🎯 Focus areas:** Timeline functionality, project management, performance, bug fixes, and UI improvements outside the preview panel.--**⚠️ Avoid for now:** Preview panel enhancements (fonts, stickers, effects) and export functionality - we're refactoring these with a new binary rendering approach.--See our [Contributing Guide](.github/CONTRIBUTING.md) for detailed setup instructions, development guidelines, and complete focus area guidance.--**Quick start for contributors:**--- Fork the repo and clone locally-- Follow the setup instructions in CONTRIBUTING.md-- Working on `apps/desktop`? See [`apps/desktop/README.md`](apps/desktop/README.md) for setup-- Create a feature branch and submit a PR+We're not set up to take outside contributions yet while the architecture is being designed. If you want to follow along, ask questions, or just hang out, [join the Discord](https://discord.gg/zmR9N35cjK) or [open an issue](https://github.com/opencut-app/opencut/issues).## License-[MIT LICENSE](LICENSE)-------+[MIT](LICENSE)\ No newline at end of filediff --git a/apps/web/public/logos/others/vercel.svg b/apps/web/public/logos/others/vercel.svgdeleted file mode 100644index 483c970d..00000000--- a/apps/web/public/logos/others/vercel.svg+++ /dev/null@@ -1,3 +0,0 @@-<svg width="588" height="512" viewBox="0 0 588 512" fill="none" xmlns="http://www.w3.org/2000/svg">-<path d="M294 0L588 512H0L294 0Z" fill="black"/>-</svg>diff --git a/apps/web/src/site/sponsors.ts b/apps/web/src/site/sponsors.tsindex 2bd201b7..e0ce94ad 100644--- a/apps/web/src/site/sponsors.ts+++ b/apps/web/src/site/sponsors.ts@@ -14,11 +14,4 @@ export const SPONSORS: Sponsor[] = [description: "Generative image, video, and audio models all in one place.",invertOnDark: true,},- {- name: "Vercel",- url: "https://vercel.com?utm_source=opencut",- logo: "/logos/others/vercel.svg",- description: "Platform where we deploy and host OpenCut.",- invertOnDark: true,- },];