Aire-One
/
awesome-slot
mirror of https://github.com/Aire-One/awesome-slot.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
A declarative API to connect signals for the AwesomeWM
22 Commits 3 Branches 0 Tags 96 KiB
Lua 97.1%
Makefile 2.9%
Go to file
Aire-One 87a767705d !feat: `connect` parameter defaults to `true` 2024-11-28 00:36:56 +01:00
.github/workflows feat: add unit tests 2024-11-17 18:50:52 +01:00
.vscode feat: add unit tests 2024-11-17 18:50:52 +01:00
doc add(doc) ldoc and base README 2021-10-16 19:36:46 +02:00
spec !feat: `connect` parameter defaults to `true` 2024-11-28 00:36:56 +01:00
src/awesome-slot !feat: `connect` parameter defaults to `true` 2024-11-28 00:36:56 +01:00
.busted feat: add unit tests 2024-11-17 18:50:52 +01:00
.cspell.json feat(slots): make predefined slots HOF 2024-11-27 01:56:10 +01:00
.editorconfig chore: add Makefile 2024-10-25 01:50:55 +02:00
.gitignore feat: reorganize as a rock 2024-10-24 18:48:49 +02:00
.luacheckrc chore: add spec directory to luacheck 2024-11-26 01:23:33 +01:00
.stylua.toml feat: reorganize as a rock 2024-10-24 18:48:49 +02:00
Makefile feat: add unit tests 2024-11-17 18:50:52 +01:00
README.md add(README) # Documentation 2024-10-24 20:47:57 +02:00
awesome-slot-dev-1.rockspec chore(rockspec): add lua dependency constraints 2024-11-27 02:02:15 +01:00
config.ld feat: reorganize as a rock 2024-10-24 18:48:49 +02:00

README.md

Awesome WM - Slot

A declarative API to connect signals for the AwesomeWM.

It completes the native gears.signal module to make signal connection easier to manage.

Documentation

API references for the latest release are available at https://aire-one.github.io/awesome-slot/index.html.

It is also possible to manually build the documentation locally using ldoc. The documentation content is part of the source code, and all configurations needed are provided by the config.ld file. To generate documentation, you need to run :

ldoc .

The documentation site will be generated in the doc directory.