Skip to content

Commit d1f4cb6

Browse files
committed
docs: fix readme
1 parent 19f1086 commit d1f4cb6

1 file changed

Lines changed: 49 additions & 22 deletions

File tree

README.md

Lines changed: 49 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,27 @@
1-
2-
| | |
3-
| --- | ---------------------------------------------------------------------- |
4-
| | OpenCutA free, open-source video editor for web, desktop, and mobile. |
5-
1+
<table width="100%">
2+
<tr>
3+
<td align="left" width="120">
4+
<img src="apps/web/public/logos/opencut/icon.svg" alt="OpenCut Logo" width="100" />
5+
</td>
6+
<td align="right">
7+
<h1>OpenCut</h1>
8+
<h3 style="margin-top: -10px;">A free, open-source video editor for web, desktop, and mobile.</h3>
9+
</td>
10+
</tr>
11+
</table>
612

713
## Sponsors
814

915
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.
1016

17+
<a href="https://vercel.com/oss">
18+
<img alt="Vercel OSS Program" src="https://vercel.com/oss/program-badge.svg" />
19+
</a>
20+
21+
<a href="https://fal.ai">
22+
<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=" />
23+
</a>
24+
1125
## Why?
1226

1327
- **Privacy**: Your videos stay on your device
@@ -33,23 +47,29 @@ Thanks to [Vercel](https://vercel.com?utm_source=github-opencut&utm_campaign=oss
3347
### Setup
3448

3549
1. Fork and clone the repository
50+
3651
2. Copy the environment file:
37-
```bash
52+
53+
```bash
3854
# Unix/Linux/Mac
3955
cp apps/web/.env.example apps/web/.env.local
4056

4157
# Windows PowerShell
4258
Copy-Item apps/web/.env.example apps/web/.env.local
43-
```
59+
```
60+
4461
3. Start the database and Redis:
45-
```bash
62+
63+
```bash
4664
docker compose up -d db redis serverless-redis-http
47-
```
65+
```
66+
4867
4. Install dependencies and start the dev server:
49-
```bash
68+
69+
```bash
5070
bun install
5171
bun dev:web
52-
```
72+
```
5373

5474
The application will be available at [http://localhost:3000](http://localhost:3000).
5575

@@ -59,7 +79,7 @@ The `.env.example` has sensible defaults that match the Docker Compose config
5979

6080
Desktop is opt-in. If you're only working on the web app, skip this entirely.
6181

62-
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.
82+
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.
6383

6484
### Local WASM development
6585

@@ -79,23 +99,30 @@ cargo install cargo-watch
7999
```
80100

81101
1. Build the package once from the repo root:
82-
```bash
102+
103+
```bash
83104
bun run build:wasm
84-
```
105+
```
106+
85107
2. Register the generated package for linking:
86-
```bash
108+
109+
```bash
87110
cd rust/wasm/pkg
88111
bun link
89-
```
112+
```
113+
90114
3. Link `apps/web` to the local package:
91-
```bash
115+
116+
```bash
92117
cd apps/web
93118
bun link opencut-wasm
94-
```
119+
```
120+
95121
4. Rebuild on changes while you work:
96-
```bash
122+
123+
```bash
97124
bun dev:wasm
98-
```
125+
```
99126

100127
To switch `apps/web` back to the published package, run:
101128

@@ -128,7 +155,7 @@ See our [Contributing Guide](.github/CONTRIBUTING.md) for detailed setup instruc
128155

129156
- Fork the repo and clone locally
130157
- Follow the setup instructions in CONTRIBUTING.md
131-
- Working on `apps/desktop`? See `[apps/desktop/README.md](apps/desktop/README.md)` for setup
158+
- Working on `apps/desktop`? See [`apps/desktop/README.md`](apps/desktop/README.md) for setup
132159
- Create a feature branch and submit a PR
133160

134161
## License
@@ -137,4 +164,4 @@ See our [Contributing Guide](.github/CONTRIBUTING.md) for detailed setup instruc
137164

138165
---
139166

140-
Star History Chart
167+
![Star History Chart](https://api.star-history.com/svg?repos=opencut-app/opencut&type=Date)

0 commit comments

Comments
 (0)