Add install guide to README

This commit is contained in:
dec05eba
2024-10-27 23:03:14 +01:00
parent 0c5335ee65
commit c9a447da8e
3 changed files with 16 additions and 3 deletions

View File

@@ -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`.

6
TODO
View File

@@ -56,4 +56,8 @@ Show navigation breadcrumbs for settings and deeper navigation (such as selectin
If recording stops because of an error then the ui wont be running and we wont get a notification that recording failed.
Add option to hide stream key like a password input.
Add option to hide stream key like a password input.
Add global setting. In that setting there should be an option to enable/disable gsr-ui from system startup (the systemd service).
Add profiles and hotkey to switch between profiles (show notification when switching profile).

View File

@@ -571,6 +571,10 @@ namespace gsr {
XFlush(display);
window_texture_deinit(&window_texture);
window_texture_sprite.set_texture(nullptr);
screenshot_texture.clear();
screenshot_sprite.set_texture(nullptr);
visible = false;
if(window) {
window->set_visible(false);