Generate Teal types definitions for the Awesome WM based on the API documentation 📄
Go to file
Aire-One cc9a724a27 build(types): ansocilors 2022-09-29 20:38:03 +02:00
.vscode feat(crawler): manage `file://` protocol 2022-09-11 03:17:40 +02:00
.woodpecker ci(lint): fix when_path 2022-08-13 03:10:11 +02:00
rockspecs feat(rockspec): remove htmlparser dependency 2022-09-29 19:20:40 +02:00
src/awesomewm.d.tl feat(scraper): use the new scraper 2022-09-29 19:20:40 +02:00
types build(types): ansocilors 2022-09-29 20:38:03 +02:00
.editorconfig build(teal): initial teal config 2022-09-29 20:38:03 +02:00
.gitignore build(teal): initial teal config 2022-09-29 20:38:03 +02:00
.luacheckrc initial 2022-06-26 17:43:18 +02:00
README.MD chore: add woodpecker status badge in README 2022-08-12 19:54:34 +02:00
debug.lua initial 2022-06-26 17:43:18 +02:00
justfile ci: woodpecker initial 2022-08-12 19:28:44 +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
tlconfig.lua build(teal): initial teal config 2022-09-29 20:38:03 +02:00

README.MD

AwesomeWM.d.tl

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

status-badge

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.