diff options
| author | dec05eba <dec05eba@protonmail.com> | 2024-10-27 23:03:14 +0100 |
|---|---|---|
| committer | dec05eba <dec05eba@protonmail.com> | 2024-10-27 23:03:14 +0100 |
| commit | c9a447da8e7c69e4afda19f37bd2e4683b52edee (patch) | |
| tree | f660d78390534d8ef6a34f40ecc7af5277037119 /README.md | |
| parent | 0c5335ee65d34e45b2f9506d38cd32d56009cdad (diff) | |
Add install guide to README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 9 |
1 files changed, 7 insertions, 2 deletions
@@ -4,6 +4,10 @@ A fullscreen overlay UI for [GPU Screen Recorder](https://git.dec05eba.com/gpu-s # Usage Run `gsr-ui` and press `Alt+Z` to show/hide the UI. You can start the overlay UI at system startup by running `systemctl enable --now --user gpu-screen-recorder-ui`. +# Installation +If you are using an Arch Linux based distro then you can find gpu screen recorder ui on aur under the name gpu-screen-recorder-ui (`yay -S gpu-screen-recorder-ui`).\ +If you are running another distro then you can run `sudo ./install.sh`, but you need to manually install the dependencies, as described below. + # Dependencies GPU Screen Recorder UI uses meson build system so you need to install `meson` to build GPU Screen Recorder UI. @@ -13,8 +17,9 @@ These are the dependencies needed to build GPU Screen Recorder UI: * x11 (libx11, libxrandr, libxrender, libxfixes, libxcomposite) * libglvnd (which provides libgl, libglx and libegl) -# Installation -Run `sudo ./install.sh`. This will install gsr-ui to `/usr/bin/gsr-ui`. You can run meson commands manually to install gsr-ui to another directory. +## Runtime dependencies +* [GPU Screen Recorder](https://git.dec05eba.com/gpu-screen-recorder/) +* [GPU Screen Recorder Notification](https://git.dec05eba.com/gpu-screen-recorder-notification/) # License This software is licensed under GPL3.0-only. Files under `fonts/` directory are licensed under `SIL Open Font License`. |