aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/README.md b/README.md
index cf3328c..e6c1a3d 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,19 @@
# GPU Screen Recorder Overlay
-A fullscreen overlay UI for [GPU Screen Recorder](https://git.dec05eba.com/gpu-screen-recorder/about/), in the style of NVIDIA ShadowPlay.
+A fullscreen overlay UI for [GPU Screen Recorder](https://git.dec05eba.com/gpu-screen-recorder/about/), in the style of ShadowPlay.
# Dependencies
-x11, xrandr, xrender, xfixes, opengl
+GPU Screen Recorder overlay uses meson build system so you need to install `meson` to build GPU Screen Recorder overlay.
+
+## Build dependencies
+These are the dependencies needed to build GPU Screen Recorder overlay:
+
+* x11 (libx11, libxrandr, libxrender, libxfixes)
+* libglvnd (which provides libgl, libglx and libegl)
+
+## Runtime dependencies
+There are also additional dependencies needed at runtime:
+
+* Noto fonts
# Installation
-Run `sudo ./install.sh`. This will install gsr-overlay to `/usr/bin/gsr-overlay`. You can run meson commands manually to install gsr-overlay to another directory. \ No newline at end of file
+Run `sudo ./install.sh`. This will install gsr-overlay to `/usr/bin/gsr-overlay`. You can run meson commands manually to install gsr-overlay to another directory.