From 6daa69635be77eefff145e32cb9cf3434390fc8d Mon Sep 17 00:00:00 2001 From: Maze Winther Date: Sun, 26 Apr 2026 20:51:32 +0200 Subject: [PATCH] fix: restore README header, badges, links, and star chart Made-with: Cursor --- README.md | 71 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 47 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 5fe7c25f..af46df56 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,26 @@ - -| | | -| --- | ---------------------------------------------------------------------- | -| | OpenCutA free, open-source video editor for web, desktop, and mobile. | - + + + + + +
+ OpenCut Logo + +

OpenCut

+

A free, open-source video editor for web, desktop, and mobile.

+
## 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. + + Vercel OSS Program + - - + + Powered by fal.ai + ## Why? @@ -37,23 +47,29 @@ Thanks to [Vercel](https://vercel.com?utm_source=github-opencut&utm_campaign=oss ### Setup 1. Fork and clone the repository + 2. Copy the environment file: - ```bash + + ```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 + + ```bash docker compose up -d db redis serverless-redis-http - ``` + ``` + 4. Install dependencies and start the dev server: - ```bash + + ```bash bun install bun dev:web - ``` + ``` The application will be available at [http://localhost:3000](http://localhost:3000). @@ -63,7 +79,7 @@ The `.env.example` has sensible defaults that match the Docker Compose config Desktop is opt-in. If you're only working on the web app, skip this entirely. -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. +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. ### Local WASM development @@ -83,23 +99,30 @@ cargo install cargo-watch ``` 1. Build the package once from the repo root: - ```bash + + ```bash bun run build:wasm - ``` + ``` + 2. Register the generated package for linking: - ```bash + + ```bash cd rust/wasm/pkg bun link - ``` + ``` + 3. Link `apps/web` to the local package: - ```bash + + ```bash cd apps/web bun link opencut-wasm - ``` + ``` + 4. Rebuild on changes while you work: - ```bash + + ```bash bun dev:wasm - ``` + ``` To switch `apps/web` back to the published package, run: @@ -132,7 +155,7 @@ See our [Contributing Guide](.github/CONTRIBUTING.md) for detailed setup instruc - 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 +- Working on `apps/desktop`? See [`apps/desktop/README.md`](apps/desktop/README.md) for setup - Create a feature branch and submit a PR ## License @@ -141,4 +164,4 @@ See our [Contributing Guide](.github/CONTRIBUTING.md) for detailed setup instruc --- -Star History Chart \ No newline at end of file +![Star History Chart](https://api.star-history.com/svg?repos=opencut-app/opencut&type=Date)