add section about known issues and add to Linux section (#537)

shiftkey · Jun 30, 2021 · 51ff604 · 51ff604
1 parent 0ad58e6
commit 51ff604
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git 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
@@ -12,6 +12,8 @@
   - [Failed to open CA file after an update](#failed-to-open-ca-file-after-an-update)
   - [`ask-pass-trampoline.bat` errors](#ask-pass-trampolinebat-errors)
   - [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
 
@@ -234,3 +236,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.