Generate Teal types definitions for the Awesome WM based on the API documentation 📄
Go to file
Aire-One f5151ab143
ci/woodpecker/push/lint Pipeline was successful Details
ci/woodpecker/pr/lint Pipeline was successful Details
ci/woodpecker/push/build Pipeline failed Details
ci/woodpecker/pr/build Pipeline failed Details
ci(lint): perform the pipeline on jusfile changes
2022-09-11 01:35:30 +02:00
.vscode feat(generator): initial 2022-08-15 15:44:00 +02:00
.woodpecker ci(lint): perform the pipeline on jusfile changes 2022-09-11 01:35:30 +02:00
rockspecs feat(generator): initial 2022-08-15 15:44:00 +02:00
src/awesomewm.d.tl feat(generator): initial 2022-08-15 15:44:00 +02:00
types build(types): update lualogging 2022-09-10 00:55:10 +02:00
.editorconfig build(teal): initial teal config 2022-08-20 12:25:09 +02:00
.gitignore build(teal): initial teal config 2022-08-20 12:25:09 +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 build(just): fix targets find command 2022-09-11 01:29:46 +02:00
set_paths.lua chore(set_paths): add teal types and build paths 2022-09-03 19:21:45 +02:00
stylua.toml initial 2022-06-26 17:43:18 +02:00
tlconfig.lua build(teal): initial teal config 2022-08-20 12:25:09 +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.