lucas/lua-libpulse-glib
lucas/lua-libpulse-glib
1
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
Var Dump: 
dumpVar: only available in dev mode
Mailing List

doc: Add disclaimer about current project state

Browse source
This commit is contained in:
Lucas Schwiderski 2022-06-22 15:33:02 +02:00
parent 9e9ac22e82
commit 5b3559bf0e
Signed by: lucas
GPG key ID: AA12679AAA6DF4D8
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.adoc
View file

@ -31,6 +31,10 @@ image:{url-luarocks-badge}[LuaRocks Package, link={url-luarocks-link}]
https://freedesktop.org/software/pulseaudio/doxygen/index.html[libpulse] bindings for use with a GLib MainLoop via
https://github.com/lgi-devs/lgi/[LGI].
The project is still in a development state. It hasn't been fully tested yet, and not all functions from libpulse
have a corresponding binding yet.
Please do report anything that's missing or not working correctly.
== Quick Start
Install https://github.com/lgi-devs/lgi[lgi] and _lua_libpulse_glib_ from LuaRocks:
@ -38,7 +42,7 @@ Install https://github.com/lgi-devs/lgi[lgi] and _lua_libpulse_glib_ from LuaRoc
[source,shell]
----
luarocks install lgi
luarocks install lua-libpulse-glib
luarocks install --dev lua-libpulse-glib
----
[source,lua]