Browse Source

Clarify additional requirements (glslValidator, no Windows) of an Android build

mcc 2 years ago
parent
commit
34036334a7
1 changed files with 4 additions and 0 deletions
  1. 4 0
      guides/Compiling.md

+ 4 - 0
guides/Compiling.md

@@ -93,6 +93,8 @@ Android
 
 
 Here be dragons.
 Here be dragons.
 
 
+You will need to compile on a macOS or Linux system. Compiling LÖVR APKs on Windows does not currently work (unless all steps are performed in [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install)).
+
 First, make sure the Java JDK is installed (version 8 is known to work).
 First, make sure the Java JDK is installed (version 8 is known to work).
 
 
 Then, the Android SDK and NDK need to be installed.  SDK version 29 should be installed.
 Then, the Android SDK and NDK need to be installed.  SDK version 29 should be installed.
@@ -112,6 +114,8 @@ Android Studio isn't required, but can be used to install the SDK, NDK, and Java
 
 
 Note where the SDK is installed.  Some paths in the SDK will need to be specified.
 Note where the SDK is installed.  Some paths in the SDK will need to be specified.
 
 
+Finally, compiling a LÖVR APK requires a copy of the `glslValidator` tool installed on the system. Most package managers will offer this as part of a "glslang" or "glslang-tools" package.
+
 CMake or tup can be used to build an APK that can be installed on an Android device.
 CMake or tup can be used to build an APK that can be installed on an Android device.
 
 
 ### tup
 ### tup