From 622d8a9f78af2d158fc6293d03574dca58350c1a Mon Sep 17 00:00:00 2001 From: Eugen Kaparulin Date: Wed, 30 Sep 2026 11:56:11 +0300 Subject: [PATCH] docs: document the Windows download MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The platform badge reads "Linux | Windows | Android" and both Windows archives ship on the releases page, but the Download section only had entries for Linux, Android and the not-yet-shipped macOS/iOS. Anyone landing from the badge had nothing to download. Details taken from docs/RELEASE_RUNBOOK.md rather than inferred from the asset names: the portable build is a self-extracting launcher that unpacks to %LOCALAPPDATA%\Korax\\, drops a Desktop shortcut, and needs no install wizard or admin rights. Neither build is code-signed, so SmartScreen warns on first run — worth saying up front rather than letting people meet it as a surprise. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 325142e..a7d894a 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,17 @@ The Linux release is a self-contained AppImage — no installation required. ./Korax-x86_64.AppImage ``` +### Windows + +Neither build is code-signed, so Windows SmartScreen will warn on first run — "More info" → "Run anyway". + +1. Download either from the [Releases](https://git.k-ops.eu/korax/korax-public/releases) page: + + | Asset | What it is | + |---|---| + | `Korax-*-windows-x86_64.zip` | Standard build. Unzip and run `korax.exe`. | + | `Korax-*-windows-x86_64-portable.zip` | Self-extracting portable. Double-click the bundled exe and it unpacks itself to `%LOCALAPPDATA%\Korax\\`, drops a Desktop shortcut and launches — no install wizard and no admin rights. | + ### Android