diff --git a/README.md b/README.md new file mode 100644 index 0000000..c87a41d --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# crater2150's awesomewm config + +Requirements: + +- [luarocks](https://luarocks.org/) + - [awesome-audiowheel](https://luarocks.org/modules/crater2150/awesome-audiowheel) + - [awesome-handy](https://luarocks.org/modules/crater2150/awesome-handy) + - [inspect](https://luarocks.org/modules/kikito/inspect) + +With luarocks installed, you can use the provided script, to install lua dependencies from luarocks: +``` +sh install_deps.sh +``` +Copy `localconf.lua.template` to `localconf.lua` and change to your tastes (contains mostly stuff that may be different between multiple machines of the same user, like monitor assignment)