From 7be867e53110f78b089972c0092e2130965c11b9 Mon Sep 17 00:00:00 2001 From: Squibid Date: Fri, 30 Jun 2023 11:16:59 -0400 Subject: add install guide --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'README.md') 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 -- cgit v1.2.1