From 70b99812b04bd9f739f980d4e697285693568d6e Mon Sep 17 00:00:00 2001 From: Brendan Forster Date: Tue, 22 Jun 2021 14:26:24 -0300 Subject: [PATCH] add section about known issues and add to Linux section (#537) --- README.md | 5 +++++ docs/known-issues.md | 10 ++++++++++ 2 files changed, 15 insertions(+) diff --git a/README.md b/README.md index 354d3b97c2d..dcc33eb7f26 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,11 @@ Arch Linux users can install GitHub Desktop from the `gnome-keyring` is required and the daemon must be launched either at login or when the X server is started. Normally this is handled by a display manager, but in other cases following the instructions found on the [Arch Wiki](https://wiki.archlinux.org/index.php/GNOME/Keyring#Using_the_keyring_outside_GNOME) will fix the issue of not being able to save login credentials. +## Known issues + +If you're having troubles with Desktop, please refer to the [Known issues](docs/known-issues.md#linux) +document for guidance and workarounds for common limitations. + ## More information Please check out the [README](https://github.com/desktop/desktop#github-desktop) diff --git a/docs/known-issues.md b/docs/known-issues.md index 48b4dd251af..908c56c9ee1 100644 --- a/docs/known-issues.md +++ b/docs/known-issues.md @@ -11,6 +11,8 @@ - [I get a black screen when launching Desktop](#i-get-a-black-screen-when-launching-desktop) - [Failed to open CA file after an update](#failed-to-open-ca-file-after-an-update) - [Authentication errors due to modified registry entries](#authentication-errors-due-to-modified-registry-entries) +- [Linux](#linux) + - [I get a white screen when launching Desktop](#i-get-a-white-screen-when-launching-desktop) # Known Issues @@ -202,3 +204,11 @@ If either the user or an application has modified the `Command Processor` regist `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Command Processor\` Check to see if there is an `Autorun` value in either of those location. If there is, deleting that value should resolve the `Authentication failed` error. + +## Linux + +### I get a white screen when launching Desktop + +Electron enables hardware accelerated graphics by default, but some graphics cards have issues with hardware acceleration which means the application will launch successfully but it will be a white screen. If you are running GitHub Desktop within virtualization software like Parallels Desktop, hardware accelerated graphics may not be available. + +**Workaround:** if you set the `GITHUB_DESKTOP_DISABLE_HARDWARE_ACCELERATION` environment variable to any value and launch Desktop again it will disable hardware acceleration on launch, so the application is usable.