awesomewm-mirrors
/
awesome-emmylua
mirror of https://github.com/awchad/awesome-emmylua.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
awesome-emmylua/.github/README.md

1.4 KiB
Raw Blame History

Awesome EmmyLua

About

AwesomeWM doesn't have good support for Lua autocompletion, so this repository is intended to rewrite documentation entirely by hand, without using generation tools.

Usage

We work with Lua using the LSP server lua-language-server created by sumneko, where its type annotations are based on EmmyLua annotations.

  • First, clone that repository somewhere on your disk using Git:
git clone https://github.com/awchad/awesome /.local/share/awesome-emmylua
  • If your Lua project folder doesn't have a .luarc.json, create one and paste the following lines:
{
  "diagnostics.globals": [
    "awesome",
    "client",
    "screen",
    "tag",
    "root"
  ],
  "workspace.library": [
    "/home/<your-username-here>/.local/share/awesome-emmylua/lua"
  ]
}
  • You now have AwesomeWM autocompletion!

License

This repository is licensed under the GNU General Public License v3.0. Please see the license file for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.