# AwesomeWM.d.tl

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

[![status-badge](https://woodpecker.aireone.xyz/api/badges/Aire-One/awesomewm.d.tl/status.svg)](https://woodpecker.aireone.xyz/Aire-One/awesomewm.d.tl)

# 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
-   Busted-tl (https://gitea.aireone.xyz/Aire-One/busted-tl)

# Run the project

```sh
# Install rocks
just local-install

# Run the main script
just run
```

Custom settings for the project can be changed in the `src/awesomewmdtl/properties.lua` file.