add install guide
This commit is contained in:
13
README.md
13
README.md
@ -2,6 +2,19 @@
|
|||||||
Eat It is a plugin manager for mpv which allows you to declare what files you
|
Eat It is a plugin manager for mpv which allows you to declare what files you
|
||||||
want from git repos.
|
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
|
## TODO
|
||||||
- move opts to a seperate file
|
- move opts to a seperate file
|
||||||
- use the present git repos instead of relying on downloading every time
|
- use the present git repos instead of relying on downloading every time
|
||||||
|
Reference in New Issue
Block a user