Skip to content

Commit 4b055af

Browse files
committed
proj: update README
1 parent 3bcb174 commit 4b055af

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,13 @@ An Engine decides how frames are sampled before they are processed by Strategies
4747

4848
### Installing
4949

50-
1. Install [Python](https://www.python.org) 3.12.6 (or above), 64-bit version.
50+
#### Pre-built Binary
51+
52+
Currently only win_amd64 is supported. No Python installation is needed. You can find the pre-built package at release page.
53+
54+
#### Install form Source
55+
56+
1. Install [Python](https://www.python.org) 3.12.6 (or above, but < 3.13), 64-bit version.
5157
2. Run `install.bat` (for Windows) or `install.sh` (for GNU/Linux or macOS). This automatically installs dependencies listed in `requirements.txt` into a Python virtual environment.
5258
3. (For Extra Job `ocr` only, not required for basic timeline generation) Install Tesseract OCR v5.3.3.20231005 (or above).
5359

@@ -68,11 +74,11 @@ Temporarily make these changes to `config.yml`:
6874
- Set `engine` to `framewise`.
6975
- Under the `framewise` section, set `debug` to `true`. This should be the default setting.
7076

71-
Then, run `MagiaTimeline.bat` (for Windows) or `MagiaTimeline.sh` (for GNU/Linux or macOS). A window will pop up showing the frames from your video with a red box at the bottom. The red box should cover the area where the subtitles are displayed. If not, adjust `dialogRect` under the `bcs`, `default` section and rerun. You don’t have to run the program to the end in debug mode; you can quit by typing 'q' in the display window.
77+
Then, run `MagiaTimeline.bat`/`MagiaTimeline.exe` (for Windows) or `MagiaTimeline.sh` (for GNU/Linux or macOS). A window will pop up showing the frames from your video with a red box at the bottom. The red box should cover the area where the subtitles are displayed. If not, adjust `dialogRect` under the `bcs`, `default` section and rerun. You don’t have to run the program to the end in debug mode; you can quit by typing 'q' in the display window.
7278

7379
If the video has a resolution too high for the display window, consider adjusting `debugPyrDown` under the `framewise` section.
7480

75-
**Productive Running**: Debug mode significantly slows down the program. After verifying alignments in debug mode, process the full video with debug off. Reset the parameters as instructed in the **Configuration** section and run `MagiaTimeline.bat` (for Windows) or `MagiaTimeline.sh` (for GNU/Linux or macOS). Once the program finishes, you should see a `MagiaTimelineOutput.ass` file generated. As a video maker, you should already be familiar with this file format. Enjoy!
81+
**Productive Running**: Debug mode significantly slows down the program. After verifying alignments in debug mode, process the full video with debug off. Reset the parameters as instructed in the **Configuration** section and run `MagiaTimeline.bat`/`MagiaTimeline.exe` (for Windows) or `MagiaTimeline.sh` (for GNU/Linux or macOS). Once the program finishes, you should see a `MagiaTimelineOutput.ass` file generated. As a video maker, you should already be familiar with this file format. Enjoy!
7682

7783
## Architecture
7884

0 commit comments

Comments
 (0)