|
1 |
| -<p align='center'> |
2 |
| - <img src='bubblesub/data/bubblesub-textured.png' alt='logo' width='50%'/> |
3 |
| -</p> |
| 1 | +## Windows Build |
4 | 2 |
|
5 |
| -<p align='center'> |
6 |
| - Simple extensible ASS subtitle editor for Linux |
7 |
| - <br /> |
8 |
| - <br /> |
9 |
| - <a href="https://travis-ci.org/rr-/bubblesub"> |
10 |
| - <img src="https://travis-ci.org/rr-/bubblesub.svg?branch=master"> |
11 |
| - </a> |
12 |
| -</p> |
13 |
| - |
14 |
| - |
15 |
| -## Features |
16 |
| - |
17 |
| -- **Python - easily extend it however you want** |
18 |
| -- Video preview |
19 |
| -- Audio preview (spectrogram) |
20 |
| -- Video band for quick assessment of scene boundaries |
21 |
| -- Audio and video are synced at all times |
22 |
| -- Spectrogram shows where subs start and end |
23 |
| -- Slow playback support (with audio pitch correction) |
24 |
| -- **I can sub an entire episode without ever having to touch the mouse** |
25 |
| -- Mouse users are not excluded and can click their way to all the commands |
26 |
| -- **Robust plugin API** (everything GUI is capable of can be done through the API) |
27 |
| -- **Simple architecture** (Commands ↔ API ↔ GUI) |
28 |
| -- Separate control for persistent inline comments (useful for translating) |
29 |
| -- Newlines support in the editor |
30 |
| -- Everything is aligned to video frames |
31 |
| -- Style editor with realistic preview |
32 |
| -- No bloat |
33 |
| - |
34 |
| -## Screenshot |
35 |
| - |
36 |
| - |
37 |
| - |
38 |
| -## Installation |
39 |
| - |
40 |
| -- Install system dependencies |
41 |
| - - Python 3.7 |
42 |
| - - [`libmpv`](https://github.com/mpv-player/mpv.git) |
43 |
| - - [`ffms`](https://github.com/FFMS/ffms2) |
44 |
| - - [`fftw`](https://github.com/FFTW/fftw3) |
45 |
| - - `Qt5` bindings |
46 |
| -- Clone the repository: `git clone https://github.com/rr-/bubblesub` |
47 |
| -- Enter its directory: `cd bubblesub` |
48 |
| -- Install `bubblesub`: `pip install --user .` |
49 |
| -- Run bubblesub: `python3 -m bubblesub` or simply `bubblesub` |
50 |
| - |
51 |
| -If you want to simplify `bubblesub` installation, look at our [Dockerfile](Dockerfile). |
52 |
| -You will find what dependencies are needed, how to install them and how to run |
53 |
| -our tests. |
54 |
| - |
55 |
| -## Documentation |
56 |
| - |
57 |
| -#### Default hotkeys and commands |
58 |
| - |
59 |
| -Please see [this file](docs/doc.md). |
60 |
| - |
61 |
| -#### API |
62 |
| - |
63 |
| -For the API documentation, for now please consult the docstrings in the |
64 |
| -`bubblesub.api` module. In the future, if bubblesub experiences a boost in |
65 |
| -popularity, this might be improved. |
66 |
| - |
67 |
| -#### Configuration and plugins |
68 |
| - |
69 |
| -- `$XDG_CONFIG_HOME/bubblesub/`: contains user configuration |
70 |
| - - `options.yaml`: general options |
71 |
| - - `hotkeys.conf`: configurable user hotkeys |
72 |
| - - `menu.conf`: configurable additional user menus |
73 |
| -- `$XDG_CONFIG_HOME/bubblesub/scripts`: contains user plugins (see [example |
74 |
| -plugin](docs/example_plugin.py)) |
75 |
| -- `$XDG_CACHE_HOME/bubblesub/`: used to cache time codes and such |
76 |
| - |
77 |
| -## Questions |
78 |
| - |
79 |
| -1. I want to report a bug. |
80 |
| - |
81 |
| - Please use GitHub issues. |
82 |
| - |
83 |
| -2. I want a feature. |
84 |
| - |
85 |
| - Chances are I'm too busy to work on features I don't personally need, |
86 |
| - so pull requests are strongly encouraged. |
87 |
| - |
88 |
| -3. Why not aegisub? |
89 |
| - |
90 |
| - Because it doesn't cover my needs, it's too convoluted and its development |
91 |
| - is too slow. |
92 |
| - |
93 |
| -4. Windows builds? |
94 |
| - |
95 |
| - This is a hobby project and wrestling with Windows to have it compile a |
96 |
| - single C dependency library isn't my idea of a well-spent afternoon. |
97 |
| - It should be possible with MSYS2. |
98 |
| - |
99 |
| -5. Versioning? PyPI? |
100 |
| - |
101 |
| - I don't say no, maybe in the future, if the project gets more popular. |
102 |
| - For now, `git master` is the way to go. |
103 |
| - |
104 |
| -## Contact |
105 |
| - |
106 |
| -**Issue tracker**: [GitHub issues](https://github.com/rr-/bubblesub) |
107 |
| - |
108 |
| -## Acknowledgments |
109 |
| - |
110 |
| -I'd like to thank all |
111 |
| -[contributors](https://github.com/rr-/bubblesub/graphs/contributors) for the |
112 |
| -help on this project. |
113 |
| -The lovely logo was donated by fri. Thanks :) |
| 3 | +This branch builds [bubblesub](https://github.com/rr-/bubblesub) for Windows. |
| 4 | +It's not maintained by the author of the program, so please don't bother him with questions relating to Windows. |
0 commit comments