Skip to content

Formerly KrillinAI, VideoTranslation and Dubbing Tool for 120+ Languages. Open-source AI workspace for creators, powered by Codex. Video downloader, video translation, create videos, images, audios, and edits with Agents in one place. For your Social Media like YouTube, TikTok, Instagram, etc.

Update README_en.md

Krillin AI5d97790dd503
diff --git a/docs/README_en.md b/docs/README_en.md
index 5cbe6e37..c2689aa1 100644
--- a/docs/README_en.md
+++ b/docs/README_en.md
@@ -13,10 +13,50 @@ Krillin AI is a one-stop solution designed for users and developers seeking high
## Key Features and Functions:
-🎯 **One-Click Deployment**: No complex environment setup required. Krillin AI allows for quick onboarding, so you can start using it immediately.
-📥 **Video Acquisition**: Integrated with the yt-dlp library, it allows direct video downloads from YouTube and Bilibili links, simplifying the material collection process.
-📜 **Subtitle Recognition**: Using the Whisper model, Krillin AI performs word-level subtitle recognition, significantly reducing hallucination errors and ensuring high-accuracy transcription.
-🧠 **Intelligent Subtitle Segmentation**: NLP and AI algorithms are used to intelligently segment subtitles, ensuring a natural and smooth reading experience.
-🔄 **Custom Vocabulary Replacement**: Supports one-click vocabulary replacement to optimize translation coherence, adaptable to specific industries or brand language styles.
-🌍 **Professional-Level Translation**: With a full-sentence translation engine, Krillin AI ensures contextual consistency, avoiding fragmented expressions.
-🎙️ **Diverse Dubbing Options**: Supports leading TTS services like Alibaba Cloud, Google Cloud, and Azure, meeting the demands of various scenarios.
\ No newline at end of file
+🎯 **One-click Start**: No complicated environment setup required. Krillin AI supports automatic dependency installation, allowing you to quickly get started and use it immediately.
+
+📥 **Video Acquisition**: Integrated with yt-dlp, directly download videos from YouTube and Bilibili links, simplifying the material collection process.
+
+📜 **Subtitle Recognition**: Using the Whisper model for subtitle recognition, ensuring high-precision transcription.
+
+🧠 **Intelligent Subtitle Segmentation and Alignment**: Utilizing self-developed algorithms to intelligently segment and align subtitles, preventing misalignment and loss of context.
+
+🔄 **Custom Vocabulary Replacement**: Supports one-click vocabulary replacement [TODO], adaptable to specific domain language styles.
+
+🌍 **Professional Translation**: Full-sentence translation engine, ensuring contextual consistency and semantic coherence.
+
+🎙️ **Diverse Voiceover Options**: Supports mainstream TTS services such as Alibaba Cloud, Google Cloud [TODO], meeting the needs of various scenarios.
+
+
+---
+## Quick Start
+### Basic Steps
+1. Download the executable file that matches your device system from the release and place it in an empty folder.
+2. Create a `config` folder inside the folder, then create a `config.toml` file in the `config` folder. Copy the content from the `config-example.toml` file in the source code's `config` directory into `config.toml` and fill in your configuration information accordingly.
+3. Double-click the executable file to start the service.
+4. Open a browser and enter `http://127.0.0.1:8888` to start using it (replace 8888 with the port you configured in the `config.toml` file).
+
+### To: macOS Users
+This software is not signed, so after completing the file configuration in the "Basic Steps," you will need to manually trust the application on macOS. Follow these steps:
+1. Open the terminal and navigate to the directory where the executable file (assuming the file name is `krillinai`) is located.
+2. Execute the following commands in sequence:
+```
+sudo xattr -rd com.apple.quarantine ./krillinai
+sudo chmod +x ./krillinai
+./krillinai
+```
+This will start the service.
+
+
+### Cookie Configuration Instructions
+
+If you encounter video download failures, please refer to the [Cookie Configuration Instructions](./docs/get_cookies.md) to configure your cookie information.
+
+---
+
+### Contribution Guidelines
+
+- Do not submit unnecessary files like `.vscode`, `.idea`, etc. Please make good use of `.gitignore` to filter them.
+- Do not submit `config.toml`; instead, submit `config-example.toml`.
+
+