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
16 Commits 3 Branches 0 Tags 73 KiB
Lua 95.7%
Makefile 4.3%
Go to file
Aire-One 44686975f4 ci: add rock workflow 2024-10-25 02:54:44 +02:00
.github/workflows ci: add rock workflow 2024-10-25 02:54:44 +02:00
.vscode feat: reorganize as a rock 2024-10-24 18:48:49 +02:00
doc add(doc) ldoc and base README 2021-10-16 19:36:46 +02:00
src/awesome-slot ci: add lint workflow 2024-10-24 20:47:57 +02:00
.cspell.json ci: add rock workflow 2024-10-25 02:54:44 +02: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 feat: reorganize as a rock 2024-10-24 18:48:49 +02:00
.stylua.toml feat: reorganize as a rock 2024-10-24 18:48:49 +02:00
Makefile ci: add rock workflow 2024-10-25 02:54:44 +02:00
README.md add(README) # Documentation 2024-10-24 20:47:57 +02:00
awesome-slot-dev-1.rockspec ci: add rock workflow 2024-10-25 02:54:44 +02: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.