aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJesús <heckyel@hyperbola.info>2019-05-15 21:58:02 -0500
committerJesús <heckyel@hyperbola.info>2019-05-15 21:58:02 -0500
commit7e4a223d1c70cb5f32a5946ae125be4d42b3c79e (patch)
tree6faa936c87cbf2d763f8f38749ac87d2a9f0f9f2 /README.md
downloadlivie-7e4a223d1c70cb5f32a5946ae125be4d42b3c79e.tar.lz
livie-7e4a223d1c70cb5f32a5946ae125be4d42b3c79e.tar.xz
livie-7e4a223d1c70cb5f32a5946ae125be4d42b3c79e.zip
initial import
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e74000f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+<p align="center">
+ <a href="http://www.gnu.org/licenses/gpl-3.0.txt">
+ <img src="https://img.shields.io/badge/license-GPL_3-green.svg" alt="License GPL 3" />
+ </a>
+</p>
+
+# Livie is Video in Emacs
+
+![screenshot](screenshot.png)
+
+Livie allows the user to search youtube.com and play the video from `mpv`.
+
+## Requeriments
+
+- `python-beautifulsoup4`
+- `python-lxml`
+- `mpv`
+- `hypervideo` or `youtube-dl`
+
+ `sudo pacman -S python-beautifulsoup4 python-lxml mpv hypervideo`
+
+## Installation
+
+``` emacs-lisp
+(require 'livie "~/.emacs.d/path/to/livie.el")
+(setq livie-script-path (expand-file-name "path/to/livie.py" user-emacs-directory))
+```
+
+## Usage
+
+Just run `M-x livie` and enter a search query. `n`, `p` and `tab`
+can be used to navigate the buffer. Type `s` to enter another search.
+To watch a video, press `<enter>`.