Improve README and docs

README.md

@@ -37,7 +37,7 @@ pipx creates an isolated environment for each program, and adds their binaries i
 - Install Python 3.8 or above.
 - Install pipx using either your package manager, `pip3 install --user pipx`, or `pip install --user pipx`.
 - Run `pipx install "corrscope[qt5]"`
-    - On Linux, to add support for native Qt themes, instead run `pipx install --system-site-packages "corrscope[qt5]"`
+    - On Linux, to add support for native Qt 6 themes, instead run `pipx install --system-site-packages "corrscope[qt6]"`
     - On FreeBSD, install `py39-qt5` and `py39-ruamel.yaml` via `pkg` or ports tree, then run `pipx install --system-site-packages "corrscope[qt5]"`. To get previews working, install `ffmpeg` via ports tree with `SDL` option enabled.
     - On M1 Mac, instead run `pipx install "corrscope[qt6]"`
 - Open a terminal and run `corr (args)`.
@@ -49,15 +49,16 @@ pip installs packages into a per-user Python environment. This has the disadvant
 - Install Python 3.8 or above.
 - If necessary, install pip using your package manager.
 - Run `pip3 install --user "corrscope[qt5]"`
+    - On Linux, to add support for native Qt 6 themes, instead run `pip3 install --user "corrscope[qt6]"`
     - On FreeBSD, install `py39-qt5` and `py39-ruamel.yaml` via `pkg` or ports tree, then run `pip install --user "corrscope[qt5]"`. To get previews working, install `ffmpeg` via ports tree with `SDL` option enabled.
     - On M1 Mac, instead run `pip3 install --user "corrscope[qt6]"`
 - Open a terminal and run `corr (args)`.
 
-### Dev builds (Windows)
+### Installing dev builds from Git (cross-platform, dev master)
 
 Windows dev builds are compiled automatically, and available at https://ci.appveyor.com/project/nyanpasu64/corrscope/history.
 
-Installing dev builds on non-Windows platforms without cloning the repo (eg. Git URLs or .whl files) is not supported yet. Fixes are welcome.
+On other platforms, follow the regular pip or pipx installation instructions, but replace `"corrscope[qt5]"` with `"corrscope[qt5] @ git+https://github.com/corrscope/corrscope.git"`. On Linux/Mac, replace `qt5` with `qt6`.
 
 ### Running from Source Code (cross-platform, dev master)
 
@@ -70,6 +71,10 @@ poetry install -E qt5  # --develop is implied
 poetry run corr (args)
 ```
 
+### Installing on Android (experimental)
+
+I've written [experimental instructions](install-android.md) to install corrscope on Android. I have not tested on a blank slate installation yet.
+
 ## GUI Tutorial
 
 1. Open GUI:

docs/index.md

@@ -237,6 +237,11 @@ I do not have experience with other encoders (like x265, VP8, VP9, or AV1), but
 
 ## Audio Encoding
 
-corrscope defaults to rendering to .mp4 files, which support a limited set of audio codecs. MP3 is a "good enough" audio codec. AAC is better in theory, but ffmpeg's AAC encoder (which corrscope uses by default, `-c:a aac`) is *bad*. However, corrscope defaults to 384 kilobits/sec (`-b:a 384k`), which should be sufficient to produce audio without obvious artifacts.
+corrscope defaults to rendering to .mp4 files, which support a limited set of audio codecs. MP3 is a "good enough" audio codec. AAC is better in theory, but ffmpeg's AAC encoder (which corrscope uses by default, `-c:a aac`) is *bad*. Opus is currently the best audio codec available, and FFmpeg has added support for Opus in MP4 files, so we use `libopus` by default. The default `-b:a 256k` [VBR](https://ffmpeg.org//ffmpeg-codecs.html#libopus-1) should be overkill for audio quality.
 
-In the future, I may enable VBR encoding, or switch to an audio codec not supported in .mp4 files, like Vorbis or Opus (which has better quality at any bitrate than even good AAC encoders). This would requires switching to a different file format like .mkv.
+
+## Missing Fonts
+
+If you install a new font and it does not work in corrscope, you may need to clear the Matplotlib font cache. In Corrscope, click on menu Tools → Reload Font List, and check if the font works now. If not, your font may be an unsupported (eg. bitmap) font.
+
+To manually reload the font list, on Windows you can delete `C:\Users\(whatever_your_username_is)\.matplotlib`.

install-android.md

@@ -0,0 +1,45 @@
+# Android installation
+
+Installing corrscope on Android is experimental and not fully supported. You can report issues on GitHub or Discord, and I will attempt to resolve them if possible.
+
+First install termux from https://f-droid.org/en/packages/com.termux/.
+
+## Installing command-line corrscope
+
+To install, open Termux and run:
+
+```sh
+pkg upgrade  # apt update+upgrade
+apt install ffmpeg matplotlib python-numpy
+pip install corrscope
+# omit corrscope[qt5] since it requires an incompatible qt5 packaging. qtpy can still find the system pyqt5.
+# when installing with pipx, use --system-site-packages.
+```
+
+To run, open Termux and run:
+
+```sh
+corr --help
+# ...
+corr file.yaml --render file.mp4
+```
+
+## Installing GUI corrscope with [termux-x11](https://github.com/termux/termux-x11)
+
+To install, open Termux and run:
+
+```sh
+pkg upgrade && apt install x11-repo  # apt update+upgrade
+apt install termux-x11-nightly pyqt5 ffplay xfwm4
+```
+- Download and install https://github.com/termux/termux-x11/releases/download/nightly/app-arm64-v8a-debug.apk
+
+To run, open Termux and run:
+
+```sh
+termux-x11 :1 -xstartup xfwm4 -dpi 120 & DISPLAY=:1 corr; kill %1
+```
+- To control the size of items on screen, change `-dpi 120` to another value. (The default DPI is 96; change this value in multiples of 24.)
+- Then return to the Android home screen and open the "Termux:X11" app. This should show the corrscope UI.
+
+When terminating a preview, you may get a popup error because ffmpeg/play on Android fails to terminate properly. The dialog can be ignored, and there is no solution at this time.