aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2024-10-31 10:00:47 +0100
committerdec05eba <dec05eba@protonmail.com>2024-10-31 10:00:47 +0100
commit0815da6f2c50750c5e5df6245ab18694402fb7c1 (patch)
tree33363c12979f1f60273b10bb08ce9bfd19935ee3 /README.md
parentea0f9e564346344d2b41e2bb8c3072a740abcfdf (diff)
README mention alpha software and bug reporting
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index e340ad3..abc6ab1 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,9 @@
![](https://dec05eba.com/images/gpu_screen_recorder_logo_small.png)
# GPU Screen Recorder UI
-A fullscreen overlay UI for [GPU Screen Recorder](https://git.dec05eba.com/gpu-screen-recorder/about/) in the style of ShadowPlay.
+A fullscreen overlay UI for [GPU Screen Recorder](https://git.dec05eba.com/gpu-screen-recorder/about/) in the style of ShadowPlay.\
+Note: This software is still in early alpha. Expect bugs, and please report any if you experience them. Some are already known, but it doesn't hurt to report them anyways.\
+You can report an issue by emailing the issue to dec05eba@protonmail.com.
# 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`.