Generate Teal types definitions for the Awesome WM based on the API documentation 📄
Go to file
Aire-One d95b678a43 build(just): rename clean -> uninstall 2022-08-07 20:56:42 +02:00
.vscode initial 2022-06-26 17:43:18 +02:00
rockspecs initial 2022-06-26 17:43:18 +02:00
src/awesomewm.d.tl scraper 2022-06-30 22:32:28 +02:00
.editorconfig initial 2022-06-26 17:43:18 +02:00
.gitignore initial 2022-06-26 17:43:18 +02:00
.luacheckrc initial 2022-06-26 17:43:18 +02:00
README.MD initial 2022-06-26 17:43:18 +02:00
debug.lua initial 2022-06-26 17:43:18 +02:00
justfile build(just): rename clean -> uninstall 2022-08-07 20:56:42 +02:00
set_paths.lua initial 2022-06-26 17:43:18 +02:00
stylua.toml initial 2022-06-26 17:43:18 +02:00

README.MD

AwesomeWM.d.tl

A project to generate Teal types definitions for the Awesome WM based on the API documentation.

Dependencies

Project dependencies :

  • Lua5.4
  • Luarocks
  • Just (optional, you can check the commands in the justfile and manually run them)

Note that additional dependencies are installed as rocks with Luarocks.

Development dependencies:

  • Luacheck
  • Stylua

Run the project

# Install rocks
just install

# Run the main script
just run

Custom settings for the project can be changed in the src/awesomewm.d.tl/properties.lua file.