summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHasanAbbadi <hasanabady55@gmail.com>2022-07-02 13:29:43 +0300
committerHasanAbbadi <hasanabady55@gmail.com>2022-07-02 13:29:43 +0300
commit2ed7b7ac566fb45a9e318aa770e9a3a64281ccc1 (patch)
tree21f726a499be2ad316ed26cf8e96b1c15380758d
parentc41e552cf449e9a2b013238cd84de07d416c2ee0 (diff)
README.md
-rw-r--r--.gitignore1
-rw-r--r--README.md32
2 files changed, 33 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..297c1d0
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+example.gif
diff --git a/README.md b/README.md
index 5085789..012d03c 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,38 @@ $ pwd
$ ln -s jaSubs/jaSubs.lua .
```
+## Requirements
+------------
+ * mpv 0.27 (I don't know if it will work with mpv front-ends.)
+ * Xorg (ignore for Mac users)
+ * composite manager; `xcompmgr` or `picom`. (ignore for Mac users)
+ * python => 3.6
+ * python-pyqt5
+ * python-numpy
+ * python-requests
+ * `sudachipy` and `sudachidict_core` (likely installed with `pip`)
+ * lua
+ * socat
+ * pkill
+ * xdotool (for hiding subtitles when minimizing mpv or switching window)
+
+## Usage
+-----
+* Start video with mpv & select subtitles.
+* F3 to start/stop jaSubs.
+ * Starts automatically with files/paths specified in jaSubs.lua
+* Point cursor over the word to get popup with translation.
+* F6 to hide/show without exiting.
+
+Buttons bellow may be reassigned in `jaSubs_config.py`
+-----
+* Left-click - show translation in your browser.
+* Right-click - translate whole sentence
+* Wheel+Ctrl - resize subtitles.
+* Wheel+Shift - change subtitles' vertical position.
+* Wheel-click - cycle through auto_pause options.
+* Wheel-click-left/right - +/- auto_pause_min_words. (fancy mouses)
+
## Notes
* Issues and Pull Request are highly appreciated