summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Lubomir I. Ivanov <neolit123@gmail.com>2017-10-29 17:58:19 +0200
committerGravatar Dirk Hohndel <dirk@hohndel.org>2017-10-29 11:06:40 -0700
commitfd2e4803a07e60f447c5734a39fac561b1fc4407 (patch)
treea1a687cd7649000f3bc1e049f980ffb2f24fe2f7
parent43b1a73022cf4dd80c4df39d381589484d67a655 (diff)
downloadsubsurface-fd2e4803a07e60f447c5734a39fac561b1fc4407.tar.gz
README: add notes about the OpenGL requirements
This commit creates a "System Requirements" section in the README. Thus far this wasn't required but the Google maps plugin introduced a complication. The next patch will attempt to add the automatic "fall back to a software renderer". Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
-rw-r--r--README13
1 files changed, 13 insertions, 0 deletions
diff --git a/README b/README
index db8c49f91..2fac8b7cd 100644
--- a/README
+++ b/README
@@ -39,6 +39,19 @@ http://subsurface-divelog.org/downloads/Subsurface-4.7.0.tgz
Detailed build instructions can be found in the INSTALL file.
+System Requirements:
+====================
+
+On desktop, the integrated Googlemaps feature of Subsurface requires a GPU
+driver that has support for at least OpenGL 2.1. If your driver does not
+support that, you may have to run Subsurface in software renderer mode.
+
+Subsurface will automatically attempt to detect this scenario, but in case
+in doesn't you may have to enable the software renderer manually with
+the following:
+1) Learn how to set persistent environment variables on your OS
+2) Set the environment variable 'QT_QUICK_BACKEND' with the value of 'software'
+
Basic Usage:
============