diff options
Diffstat (limited to 'docs/libraries/references.md')
| -rw-r--r-- | docs/libraries/references.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/libraries/references.md b/docs/libraries/references.md new file mode 100644 index 0000000..8f2bd02 --- /dev/null +++ b/docs/libraries/references.md @@ -0,0 +1,44 @@ +# References + +The references of the libraries are annotated for the C language. +Reading their documentation will vary depending on the language they are used in. + +<!--TODO: list some examples on how to read docs,--> +<!--for example the difference between C enums and gjs enums--> + +## Additional references + +### GJS + +- [gjs-docs.gnome.org](https://gjs-docs.gnome.org/): Library references annotated for GJS +- [gjs.guide](https://gjs.guide/): GJS and GObject guide + +### Python + +- [pgi-docs](https://lazka.github.io/pgi-docs/): Library references annotated for Python +- [pygobject.gnome.org](https://pygobject.gnome.org/): PyGObject reference and guide + +### Lua + +- [lua-lgi docs](https://github.com/lgi-devs/lgi/tree/master/docs): GObject bindings guide for Lua + +### Vala + +- [vala.dev](https://vala.dev/): Guide for the Vala language +- [valadoc.org](https://valadoc.org/): Library references annotated for Vala + +## Astal Libraries + +- [Astal](https://aylur.github.io/libastal): libastal the core library, which has the widgets and utilites +- [Apps](https://aylur.github.io/libastal/apps): Library and cli tool for querying applications +- [Auth](https://aylur.github.io/libastal/auth): Authentication library using PAM +- [Battery](https://aylur.github.io/libastal/battery): DBus proxy library for upower daemon +- [Bluetooth](https://aylur.github.io/libastal/bluetooth): Library to control bluez over dbus +- [Hyprland](https://aylur.github.io/libastal/hyprland): Library and cli tool for Hyprland IPC socket +- [Mpris](https://aylur.github.io/libastal/mpris): Library and cli tool for controlling media players +- [Network](https://aylur.github.io/libastal/network): NetworkManager wrapper library +- [Notifd](https://aylur.github.io/libastal/notifd): A notification daemon library and cli tool +- [PowerProfiles](https://aylur.github.io/libastal/powerprofiles): Library and cli to control upowerd powerprofiles +- [River](https://aylur.github.io/libastal/river): Library and cli tool for getting status information of the river wayland compositor +- [Tray](https://aylur.github.io/libastal/tray): A systemtray library and cli tool +- [WirePlumber](https://aylur.github.io/libastal/wireplumber): A library for audio control using wireplumber |