From c676fcefb1fc37fb6497aa453606dd0352cf3b1b Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Tue, 27 Nov 2018 10:55:24 +1000 Subject: [PATCH] README: minor improvements (#565) Notable: parts of the instructions have been punted to the wiki now where it's faster to edit and be verbose about the specific instructions. Signed-off-by: Peter Hutterer --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b013ca77..bba433a6 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,16 @@ hardware-specific and kernel-specific quirks. libratbag exports the devices over a DBus daemon called **ratbagd**, see the [ratbagd DBus Interface description](https://libratbag.github.io/). +Users interact through a GUI like +[Piper](https://github.com/libratbag/piper/). For developers, the +`ratbagctl` tool is the prime tool for debugging. + +Installing libratbag from system packages +----------------------------------------- + +libratbag is packaged for some distributions, you can use your system's +package manager to install it. See [the +wiki](https://github.com/libratbag/libratbag/wiki/Installation) for details. Compiling libratbag ------------------- @@ -17,7 +27,11 @@ libratbag and initialize the build: git clone https://github.com/libratbag/libratbag.git cd libratbag - meson builddir --prefix=/usr/ + meson builddir + +This will inititialize libratbag so that it installs under `/usr/local`, +i.e. it will not overwrite the system installation. For more information, +see [the wiki](https://github.com/libratbag/libratbag/wiki/Installation). And to build or re-build after code-changes, run: