aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSquibid <me@zacharyscheiman.com>2023-06-30 11:16:59 -0400
committerSquibid <me@zacharyscheiman.com>2023-06-30 11:16:59 -0400
commit7be867e53110f78b089972c0092e2130965c11b9 (patch)
tree00fa4a793d1716ee4d318099755ff225cc5e45e4
parent25043cf37edc469ea97851011b058bdc480edb5e (diff)
downloadeat-it-7be867e53110f78b089972c0092e2130965c11b9.tar.gz
eat-it-7be867e53110f78b089972c0092e2130965c11b9.tar.bz2
eat-it-7be867e53110f78b089972c0092e2130965c11b9.zip
add install guide
Diffstat (limited to '')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 52576ce..9c12cdf 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,19 @@
Eat It is a plugin manager for mpv which allows you to declare what files you
want from git repos.
+## Installing Eat It
+To install Eat It simply put the `eatit.lua` file into your mpv scripts
+directory (~/.config/mpv/scripts by default on linux). After you have done that
+Eat It is installed, however it won't do anything without the `eatit-cfg.lua`,
+which has to be placed in the root of your mpv config dir (~/.config/mpv by
+default on linux).
+
+Alternatively you can run these two commands:
+```sh
+curl -L https://git.squi.bid/eat-it/tree/eatit.lua -o ~/.config/mpv/scripts/eatit.lua
+curl -L https://git.squi.bid/eat-it/tree/eatit-cfg.lua -o ~/.config/mpv/eatit-cfg.lua
+```
+
## TODO
- move opts to a seperate file
- use the present git repos instead of relying on downloading every time