Skip to content

Commit 2ce4547

Browse files
authored
Update README.md
1 parent 3fa856e commit 2ce4547

1 file changed

Lines changed: 85 additions & 36 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 85 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,27 @@
11
# 🎧 AutoCaption
22

33
**Automatic caption generation powered by OpenAI Whisper**
4-
Easily transcribe and generate SRT captions from audio or video files β€” with a beautiful, modern interface.
4+
Transcribe audio or video files and generate SRT captions with ease β€” all through a clean, modern interface.
55

66
> πŸ’‘ If you find this project helpful, please consider giving it a **⭐️** β€” it really helps support continued development!
77
8-
**Are you a Mac OS user? Please check [here](https://github.com/jay-bman725/AutoCaption/tree/main?tab=readme-ov-file#-macos-users--app-is-damaged-fix) to make the app run after copying to the Applications directory**
8+
**πŸ“Œ macOS Users:**
9+
If you encounter an β€œapp is damaged” error, [click here for a fix](https://github.com/jay-bman725/AutoCaption/tree/main?tab=readme-ov-file#-macos-users--app-is-damaged-fix).
910

1011
---
1112

1213
## ✨ Features
1314

14-
- πŸ”‘ **Plug & Play** β€” Just enter your OpenAI API key and you're ready to go
15-
- 🎞 **Wide Format Support** β€” MP3, WAV, MP4, AVI, MOV, MKV, and more
16-
- πŸ—œοΈ **Smart Processing** β€” Converts videos to MP3, compresses large audio files only when needed
17-
- πŸ“ **Size Optimization** β€” Automatically handles OpenAI's 25MB limit with intelligent compression
18-
- 🧠 **Whisper-Powered** β€” Uses OpenAI Whisper to generate high-quality captions
19-
- πŸ“ **Preview & Edit** β€” View captions before exporting to SRT
20-
- πŸ“ **Drag & Drop** β€” Upload files with ease
21-
- πŸ–₯ **Cross-platform** β€” Runs on Windows, macOS (Intel + Apple Silicon), and Linux
22-
- 🎨 **Modern UI** β€” Built with Electron, designed for clarity and speed
15+
- πŸ”‘ **Plug & Play** β€” Enter your OpenAI API key and get started immediately
16+
- 🎞 **Wide Format Support** β€” Supports MP3, WAV, MP4, AVI, MOV, MKV, and more
17+
- πŸ—œοΈ **Smart Processing** β€” Converts video to audio and compresses only when needed
18+
- πŸ“ **Automatic Size Optimization** β€” Handles OpenAI’s 25MB limit intelligently
19+
- 🧠 **Powered by Whisper** β€” Uses OpenAI Whisper for accurate, high-quality captions
20+
- πŸ“ **Preview & Edit** β€” View and edit captions before exporting (text only)
21+
- πŸ“ **Drag & Drop** β€” Drop in your files or use the file picker
22+
- πŸ–₯ **Cross-platform** β€” Compatible with Windows, macOS (Intel + Apple Silicon), and Linux
23+
- 🎨 **Modern UI** β€” Sleek, responsive interface built with Electron
24+
- πŸŒ“ **Customizable Theme** β€” Choose Light, Dark, or follow your system setting
2325

2426
---
2527

@@ -49,36 +51,36 @@ Easily transcribe and generate SRT captions from audio or video files β€” with a
4951

5052
---
5153

52-
### πŸ“¦ From GitHub Releases
54+
### πŸ“¦ Prebuilt Installers
5355

54-
Prebuilt installers for **Windows, macOS (arm64 + x64), and Linux** are available under the [Releases tab](https://github.com/jay-bman725/AutoCaption/releases/).
55-
Just download, install, and go.
56+
Installers for **Windows, macOS, and Linux** are available under the [Releases tab](https://github.com/jay-bman725/AutoCaption/releases).
57+
Just download, install, and you're good to go.
5658

5759
---
5860

5961
## πŸ§ͺ Usage
6062

61-
1. Launch the app (or run it with `npm start`).
62-
2. Enter your OpenAI API key when prompted.
63-
3. Upload an audio or video file via drag-and-drop or file picker.
64-
4. Click **β€œGenerate SRT Captions.”**
65-
5. Preview and download your caption file.
63+
1. Launch the app (or run with `npm start`)
64+
2. Enter your OpenAI API key when prompted
65+
3. Upload an audio or video file via drag-and-drop or the file picker
66+
4. Click **β€œGenerate SRT Captions”**
67+
5. Preview and export your SRT file
6668

6769
---
6870

6971
## 🧰 Development
7072

71-
Start in development mode with hot-reloading and DevTools:
73+
Run in development mode with hot-reloading and DevTools:
7274

7375
```bash
7476
npm run dev
7577
```
7678

7779
---
7880

79-
## πŸ— Building
81+
## πŸ— Build for Distribution
8082

81-
Create platform-specific builds for distribution:
83+
Generate platform-specific builds:
8284

8385
```bash
8486
npm run build
@@ -89,51 +91,98 @@ npm run build
8991
## 🎞 Supported Formats
9092

9193
**Audio**: MP3, WAV, M4A, AAC, OGG, WMA
94+
9295
**Video**: MP4, AVI, MOV, MKV, FLV, WEBM
9396

9497
---
9598

9699
## πŸ’» Requirements
97100

98-
* Node.js 16+
99-
* An OpenAI API key (with Whisper support)
100-
* FFmpeg installed on your system (for video conversion)
101-
* macOS, Windows, or Linux
101+
* **Node.js**: Version 16 or higher
102+
* **OpenAI API Key**: With Whisper access
103+
* **FFmpeg**: Installed and accessible in your system's PATH
104+
* **Operating System**:
105+
106+
* **macOS**: Version 10.15 (Catalina) or later, supporting both Intel and Apple Silicon architectures
107+
* **Windows**: Windows 10 (Build 1809) or newer
108+
* **Linux**:
109+
110+
* **AppImage Support**: Compatible with most 64-bit Linux distributions, including:
111+
112+
* Ubuntu 20.04 LTS or newer
113+
* Fedora 33 or newer
114+
* Debian 10 (Buster) or newer
115+
* openSUSE Leap 15.2 or newer
116+
* **Note**: Ensure that your system has GTK 3 or higher installed, as Electron applications require it for proper functionality.
117+
118+
---
119+
120+
## πŸ“¦ Install FFmpeg
102121

103-
### Installing FFmpeg
122+
**macOS (with Homebrew):**
104123

105-
**macOS** (with Homebrew):
106124
```bash
107125
brew install ffmpeg
108126
```
109127

110-
**Windows**:
111-
Download from [https://ffmpeg.org/download.html](https://ffmpeg.org/download.html) or use chocolatey:
128+
**Windows (with Chocolatey):**
129+
112130
```bash
113131
choco install ffmpeg
114132
```
115133

116-
**Linux** (Ubuntu/Debian):
134+
**Windows (Installer from FFmpeg)**
135+
https://ffmpeg.org/download.html
136+
137+
**Linux (Debian/Ubuntu):**
138+
117139
```bash
118140
sudo apt update && sudo apt install ffmpeg
119141
```
120142

143+
**For a more in-depth guide, visit [here](https://www.hostinger.com/tutorials/how-to-install-ffmpeg)**
144+
121145
---
122146

123-
## 🍏 macOS Users β€” β€œApp is damaged” Fix
147+
## 🍏 macOS Users β€” β€œApp is Damaged” Fix
124148

125-
If you see a message saying **"AutoCaption is damaged and can’t be opened"**, it's just macOS being overly strict with unsigned apps.
149+
If you get the error:
150+
**"AutoCaption is damaged and can’t be opened"** β€” don’t worry. This is due to macOS being strict about unsigned apps.
126151

127-
To fix it:
152+
Fix it with:
128153

129154
```bash
130155
xattr -cr /Applications/AutoCaption.app
131156
```
132157

133-
That removes the quarantine flag. Then it should open just fine.
158+
That clears the quarantine flag. The app should open normally afterward.
159+
160+
---
161+
162+
## πŸ“ TODO
163+
164+
Planned features for upcoming versions:
165+
166+
* 🌐 **Auto-Updater**
167+
Seamless updates via GitHub
168+
169+
* πŸ“€ **More Export Formats**
170+
Support for VTT and other formats
171+
172+
* πŸ—‚ **Batch Processing**
173+
Transcribe multiple files at once
174+
175+
* 🌍 **Language Selection**
176+
Select Whisper transcription languages
177+
178+
* πŸ’Ύ **Transcript History**
179+
Save and revisit previous transcriptions
180+
181+
* πŸ” **Live Preview**
182+
Real-time subtitle rendering during playback
134183

135184
---
136185

137186
## πŸ“„ License
138187

139-
[MIT License](./LICENSE)
188+
Released under the [MIT License](./LICENSE)

0 commit comments

Comments
Β (0)