Update README for local tests

Author: brackeen

tests/README.md

@@ -1,52 +1,65 @@
 # GLFM build tests
 
-## Automated tests
+The scripts in this directory test building GLFM and the GLFM examples. The analyzer `clang-tidy` is used if it is
+available.
 
-The [build.yml](../.github/workflows/build.yml) GitHub Action builds GLFM automatically for all target platforms and arc
-hitectures. Builds fail on compilation warnings or analyzer warnings.
+## Requirements
 
-The [build_examples.yml](../.github/workflows/build_examples.yml) GitHub Action builds GLFM examples automatically.
-Builds fail if deprecated functions are used.
+* CMake
+* Emscripten SDK
+* Android SDK/NDK
+* Xcode and xcpretty (macOS only)
+* clang-tidy (optional)
+
+### Linux host
 
-## Manual tests
+* Install CMake and clang-tidy with: `sudo apt install cmake clang-tidy`.
 
-The scripts in this directory are similar to the GitHub Actions. The scripts work on Linux, macOS, and Windows (tested
-with git-bash/MINGW64). CMake is required.
+### macOS host
 
-When running `build_all.sh`, GLFM is conditionally built for each target platform based on the tools installed:
+* Install Xcode from the App Store or from <https://developer.apple.com/download/applications/>.
+* Install CMake and xcpretty: `brew install cmake xcpretty`.
+* Optionally, install LLVM for clang-tidy: `brew install llvm`.
+* Launch Xcode once to make sure the iOS platform is installed.
 
-* Apple platforms: Xcode is installed (macOS only).
-* Emscripten: emsdk is installed (`emcmake` is in the path).
-* Android: Android NDK 17 or newer is installed (`ANDROID_NDK_HOME` environment variable is set).
+### Windows host
 
-On macOS, `ANDROID_NDK_HOME` is something like "~/Library/Android/sdk/ndk/23.2.8568313".
+* Install Git and CMake: `winget install Git.Git Kitware.CMake`.
+* For Emscripten, install Python and Ninja: `winget install python3 Ninja-build.Ninja`.
+* For Android, install OpenJDK: `winget install openjdk`.
+* Optionally, install LLVM for clang-tidy: `winget install LLVM.LLVM`.
 
-## Analyzing with clang-tidy
+### Android
 
-The build scripts run `clang-tidy` if it is available.
+* Install either Android Studio or the Android command line tools from <https://developer.android.com/studio>.
+* Install the NDK, either in Android Studio's SDK manager, or using command line with something like:
+  ```
+  sdkmanager --list | grep ndk
+  sdkmanager --install "ndk;28.0.13004108"
+  ```
+* Set the `ANDROID_NDK_HOME` environment variable to the location of the NDK, which looks something like:
+  `~/Library/Android/sdk/ndk/28.0.13004108`.
 
-The [clang-tidy-analyze.yml](clang-tidy-analyze.yml) file includes the parent [.clang-tidy](../.clang-tidy) checks and
-adds analyzer checks. Those extra analyzer checks take a bit longer to run.
+### Emscripten
 
-The current list of checks in [.clang-tidy](../.clang-tidy) will likely change in the future.
+Install Emscripten SDK from <https://emscripten.org/docs/getting_started/downloads.html>. Alternatively, on macOS, use
+`brew install emscripten`.
 
-For Apple platforms ([build_apple.sh](build_apple.sh)), the process of extracting info from `xcodebuild` and sending it
-to `clang-tidy` is a bit fragile and will likely break in the future. As of now, it works with Xcode 14.3 and clang-tidy
-16.
+The tests require that `emcmake` is in the path.
 
-### Installing clang-tidy
+## Running
 
-For Android targets, the Android NDK has a built in `clang-tidy`.
+Use `./build_all.sh` to run all tests.
 
-For Emscripten targets on Ubuntu, install clang-tidy:
+On Windows, use `"C:\Program Files\Git\bin\bash.exe" build_all.sh`.
 
-```
-sudo apt install clang-tidy
-```
+If a build fails, try `./build_all.sh -v`.
 
-For Apple targets, both `xcpretty` and `clang-tidy` are required:
+## Automated tests
+
+The [build.yml](../.github/workflows/build.yml) GitHub Action builds GLFM automatically for all target platforms and
+architectures. Builds fail on compilation warnings or analyzer warnings.
 
-```
-brew install xcpretty llvm
-```
+The [build_examples.yml](../.github/workflows/build_examples.yml) GitHub Action builds GLFM examples automatically.
+Builds fail if deprecated functions are used.