add bootstrap script and better instructions for installation

This commit is contained in:
2023-07-28 19:23:26 -04:00
parent 80de336bdb
commit af125691f7
2 changed files with 12 additions and 7 deletions

View File

@ -3,25 +3,22 @@ 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:
### Fist time
To install eatit run these two commands [Make sure you know what it does](https://explainshell.com/explain?cmd=curl+-L+https%3A%2F%2Fgit.squi.bid%2Feat-it%2Fplain%2Featit.lua+-o+~%2F.config%2Fmpv%2Fscripts%2Featit.lua+curl+-L+https%3A%2F%2Fgit.squi.bid%2Feat-it%2Fplain%2Featit-cfg.lua+-o+~%2F.config%2Fmpv%2Featit-cfg.lua):
```sh
curl -L https://git.squi.bid/eat-it/plain/eatit.lua -o ~/.config/mpv/scripts/eatit.lua
curl -L https://git.squi.bid/eat-it/plain/eatit-cfg.lua -o ~/.config/mpv/eatit-cfg.lua
```
### Bootstraping
The included bootstrap script will install and load eatit as soon as mpv starts.
## FAQ
Q: Where does the name 'Eat It' come from?
A: The plugin manager eats all the useless files and keeps the ones you want,
*and Weird Al is a funny guy*
## TODO
- make an auto install script that can be put into a mpv config
## ALTERNATIVES
[email me](mailto:me@zacharyscheiman.com) if you know of any alternatives