summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMaze Winther <mazewinther@gmail.com>2026-05-02 16:51:01 +0200
committerMaze Winther <mazewinther@gmail.com>2026-05-02 16:51:01 +0200
commitd1f4cb615b7fe5e08628119fceec075fbb5044a7 (patch)
treeac70dfce7495ef1c133b8980109e18b6eb981810 /README.md
parent19f1086492a7932c7a9d4030f3fc01fe39da58ef (diff)
downloadopencut-d1f4cb615b7fe5e08628119fceec075fbb5044a7.tar.gz
docs: fix readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md71
1 files changed, 49 insertions, 22 deletions
diff --git a/README.md b/README.md
index 79bcf310..af46df56 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,27 @@
-
-| | |
-| --- | ---------------------------------------------------------------------- |
-| | OpenCutA free, open-source video editor for web, desktop, and mobile. |
-
+<table width="100%">
+ <tr>
+ <td align="left" width="120">
+ <img src="apps/web/public/logos/opencut/icon.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>
+ </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
@@ -33,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).
@@ -59,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
@@ -79,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:
@@ -128,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
@@ -137,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)