Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Luni-4 committed Jun 24, 2019
1 parent ce223c3 commit a7fa5c1
Showing 1 changed file with 3 additions and 112 deletions.
115 changes: 3 additions & 112 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,113 +1,4 @@
<p align='center'>
<img src='bubblesub/data/bubblesub-textured.png' alt='logo' width='50%'/>
</p>
## Windows Build

<p align='center'>
Simple extensible ASS subtitle editor for Linux
<br />
<br />
<a href="https://travis-ci.org/rr-/bubblesub">
<img src="https://travis-ci.org/rr-/bubblesub.svg?branch=master">
</a>
</p>


## Features

- **Python - easily extend it however you want**
- Video preview
- Audio preview (spectrogram)
- Video band for quick assessment of scene boundaries
- Audio and video are synced at all times
- Spectrogram shows where subs start and end
- Slow playback support (with audio pitch correction)
- **I can sub an entire episode without ever having to touch the mouse**
- Mouse users are not excluded and can click their way to all the commands
- **Robust plugin API** (everything GUI is capable of can be done through the API)
- **Simple architecture** (Commands ↔ API ↔ GUI)
- Separate control for persistent inline comments (useful for translating)
- Newlines support in the editor
- Everything is aligned to video frames
- Style editor with realistic preview
- No bloat

## Screenshot

![](docs/screen.png)

## Installation

- Install system dependencies
- Python 3.7
- [`libmpv`](https://github.com/mpv-player/mpv.git)
- [`ffms`](https://github.com/FFMS/ffms2)
- [`fftw`](https://github.com/FFTW/fftw3)
- `Qt5` bindings
- Clone the repository: `git clone https://github.com/rr-/bubblesub`
- Enter its directory: `cd bubblesub`
- Install `bubblesub`: `pip install --user .`
- Run bubblesub: `python3 -m bubblesub` or simply `bubblesub`

If you want to simplify `bubblesub` installation, look at our [Dockerfile](Dockerfile).
You will find what dependencies are needed, how to install them and how to run
our tests.

## Documentation

#### Default hotkeys and commands

Please see [this file](docs/doc.md).

#### API

For the API documentation, for now please consult the docstrings in the
`bubblesub.api` module. In the future, if bubblesub experiences a boost in
popularity, this might be improved.

#### Configuration and plugins

- `$XDG_CONFIG_HOME/bubblesub/`: contains user configuration
- `options.yaml`: general options
- `hotkeys.conf`: configurable user hotkeys
- `menu.conf`: configurable additional user menus
- `$XDG_CONFIG_HOME/bubblesub/scripts`: contains user plugins (see [example
plugin](docs/example_plugin.py))
- `$XDG_CACHE_HOME/bubblesub/`: used to cache time codes and such

## Questions

1. I want to report a bug.

Please use GitHub issues.

2. I want a feature.

Chances are I'm too busy to work on features I don't personally need,
so pull requests are strongly encouraged.

3. Why not aegisub?

Because it doesn't cover my needs, it's too convoluted and its development
is too slow.

4. Windows builds?

This is a hobby project and wrestling with Windows to have it compile a
single C dependency library isn't my idea of a well-spent afternoon.
It should be possible with MSYS2.

5. Versioning? PyPI?

I don't say no, maybe in the future, if the project gets more popular.
For now, `git master` is the way to go.

## Contact

**Issue tracker**: [GitHub issues](https://github.com/rr-/bubblesub)

## Acknowledgments

I'd like to thank all
[contributors](https://github.com/rr-/bubblesub/graphs/contributors) for the
help on this project.
The lovely logo was donated by fri. Thanks :)
This branch builds [bubblesub](https://github.com/rr-/bubblesub) for Windows.
It's not maintained by the author of the program, so please don't bother him with questions relating to Windows.

0 comments on commit a7fa5c1

Please sign in to comment.