awesomewm-mirrors
/
awesome-emmylua
mirror of https://github.com/awchad/awesome-emmylua.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Hand rewriting all the awesome documentation with EmmyLua support
18 Commits 1 Branch 0 Tags 202 KiB
Lua 100%
Go to file
devclyde 65750d0f24
fix: fix column width 		2022-06-24 13:19:53 -03:00
.github feat: setup github markdowns 2022-06-23 12:59:43 -03:00
lua/gears feat: add documentation for `gears.math` 2022-06-24 12:09:34 -03:00
.editorconfig feat: initial commit 2022-06-22 22:30:16 -03:00
.gitignore feat: add git ignore 2022-06-23 13:07:37 -03:00
.stylua.toml fix: fix column width 2022-06-24 13:19:53 -03:00
COPYING feat: setup github markdowns 2022-06-23 12:59:43 -03:00

.github/README.md

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.