From 96759fe064e3a4ef07870e85b571c41e6fc4015f Mon Sep 17 00:00:00 2001 From: EtienneLescot Date: Mon, 24 Aug 2026 12:39:32 +0200 Subject: [PATCH 1/2] docs: publish minimum and recommended system requirements The download page invited anyone on "Windows 10 & 11" with no hardware qualifier, and nothing else -- README, install docs -- said anything about minimum specs either. That gap is part of why #460 took as long as it did to diagnose: reporters on a decade-old Intel iGPU had no way to know their hardware was the likely cause before hitting a confusing recording-stop failure. Added a system requirements section to website/docs/installation.md (the canonical, full version), a condensed one in README.md linking out to it, and a short note with a link on the Windows card of the download page -- the point where a user on old hardware would otherwise download with no warning at all. The Windows floor (Intel 8th Gen / Ryzen 2000, matching Camtasia's published minimum) is chosen to sit above both hardware profiles #460 reproduced on (Haswell/HD 4600, Skylake/HD 520) with room to spare, without reaching for an unrealistically high bar -- checked against Intel's own driver support tiers first, but those have moved forward enough (legacy status now reaches through 10th-11th Gen) that using them as the line would exclude hardware still in common use. Documented only, not enforced: no startup detection or install blocking, consistent with the project's own read that a hard block isn't worth building without stronger signal on how many users are actually affected. Verified: tsc --noEmit and biome clean, docusaurus build succeeds, and a local render of both the docs and download pages confirms the table, the admonition, and the download-page link to #system-requirements all resolve correctly. Co-Authored-By: Claude Sonnet 5 --- README.md | 9 +++++++++ website/docs/installation.md | 13 +++++++++++++ website/src/pages/download.tsx | 11 +++++++++-- 3 files changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 88c05f3de..a3422f532 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,15 @@ See [docs/cli.md](./docs/cli.md). Every platform has a recommended route below. On Windows that is the Microsoft Store; everywhere else it is the installer from the [GitHub Releases](https://github.com/getopenscreen/openscreen/releases) page. +### System requirements + +- **Windows**: version 1903+ (build 18362), Intel 8th Gen / AMD Ryzen 2000 series or newer recommended +- **macOS**: 12.3 (Monterey) or later — required by ScreenCaptureKit for native capture +- **Linux**: a desktop with `xdg-desktop-portal` and PipeWire (default on Ubuntu 22.04+, Fedora 34+) +- **RAM**: 8 GB minimum, 16 GB recommended + +Full table and notes on older integrated graphics: [system requirements](https://getopenscreen.com/docs/installation#system-requirements). + ### macOS Download the `.dmg` installer directly from the [Releases page](https://github.com/getopenscreen/openscreen/releases) and drag OpenScreen into your Applications folder. Builds from 1.9.0 onward are signed with a Developer ID certificate and notarized by Apple, so Gatekeeper does not block them and no terminal step is needed. diff --git a/website/docs/installation.md b/website/docs/installation.md index 4a7e87809..953035dfa 100644 --- a/website/docs/installation.md +++ b/website/docs/installation.md @@ -18,6 +18,19 @@ keywords: Download the latest installer for your platform from the [download page](/download), or straight from [GitHub Releases](https://github.com/getopenscreen/openscreen/releases). +## System requirements + +| | Minimum | Recommended | +|---|---|---| +| **Windows** | Windows 10 version 1903 (build 18362) or later, Intel 8th Gen / AMD Ryzen 2000 series or newer | Windows 11, Intel 12th Gen / AMD Ryzen 4000 series or newer | +| **macOS** | macOS 12.3 (Monterey) — required by ScreenCaptureKit for native capture | macOS 14 or later | +| **Linux** | A desktop with `xdg-desktop-portal` and PipeWire (default on Ubuntu 22.04+, Fedora 34+) | Same, kept up to date | +| **RAM** | 8 GB | 16 GB | + +:::note Older integrated graphics on Windows +Machines with integrated graphics older than roughly 8th-generation Intel (or the equivalent AMD Ryzen 2000 series) are not blocked from installing, but some have known driver stability issues that can make a recording fail to stop and save — see [#460](https://github.com/getopenscreen/openscreen/issues/460). If you hit this, open the tray icon or **Help → Save Diagnostics** right after the failure (before starting another recording) and attach the file to a bug report. +::: + ## macOS Download the `.dmg` installer from [Releases](https://github.com/getopenscreen/openscreen/releases) and drag OpenScreen into your Applications folder. Builds from 1.9.0 onward are signed with a Developer ID certificate and notarized by Apple, so Gatekeeper does not block them and no terminal step is needed. diff --git a/website/src/pages/download.tsx b/website/src/pages/download.tsx index fec64fe17..1e5ac6001 100644 --- a/website/src/pages/download.tsx +++ b/website/src/pages/download.tsx @@ -11,6 +11,7 @@ import { ShieldCheck, TerminalSquare, } from "lucide-react"; +import type { ReactNode } from "react"; import { type AssetKind, findAsset, formatSize, type LatestRelease } from "../lib/release"; import { jsonLd, SOFTWARE_ID, softwareApplicationLd, WEBSITE_ID } from "../lib/structured-data"; @@ -33,7 +34,7 @@ type PlatformSpec = { icon: typeof Apple; /** One row per artifact the platform actually ships. */ options: { kind: AssetKind; label: string; sublabel: string }[]; - footnote?: string; + footnote?: ReactNode; }; const PLATFORMS: PlatformSpec[] = [ @@ -52,7 +53,13 @@ const PLATFORMS: PlatformSpec[] = [ name: "Windows", icon: AppWindow, options: [{ kind: "windows", label: "Windows 10 & 11", sublabel: "Installer · .exe" }], - footnote: "System audio is captured without extra drivers.", + footnote: ( + <> + System audio is captured without extra drivers. Integrated graphics older than ~8th-gen + Intel may hit known recording-stop issues — see{" "} + system requirements. + + ), }, { id: "linux", From fad7ae998e736ab2f2005a1142d36ef9616c207f Mon Sep 17 00:00:00 2001 From: EtienneLescot Date: Mon, 24 Aug 2026 12:50:59 +0200 Subject: [PATCH 2/2] docs: address CodeRabbit review on the system requirements PR Three findings, all confirmed against the actual app behavior and against each other: - README.md's condensed Windows bullet buried the recommended tier and read as if "8th Gen / Ryzen 2000" were the recommended spec rather than the minimum, contradicting installation.md's table where 8th Gen is the floor and 12th Gen is recommended. Rewrote it to state both tiers explicitly, matching the canonical table. - The Linux row in both files stated xdg-desktop-portal/PipeWire as an unconditional requirement, but the app's own capture-backend table (recording.md) documents a browser-capture fallback when the native helper is unavailable -- the requirement is native capture and system audio specifically, not "the app running at all." Reworded both and linked to the existing Platform differences section, which already describes the fallback's reduced capabilities. - download.tsx's Windows card warning named only Intel generations, while the fuller note it links to (installation.md) also names the AMD Ryzen 2000 series equivalent -- an AMD user on old hardware got no warning at all before downloading. Added the same AMD clause. Verified: tsc --noEmit clean, docusaurus build succeeds, and a local render of both pages confirms the reworded table cell, the #platform-differences anchor link resolves to a real heading, and the download-page footnote now includes AMD. Co-Authored-By: Claude Sonnet 5 --- README.md | 4 ++-- website/docs/installation.md | 2 +- website/src/pages/download.tsx | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a3422f532..679bc12d3 100644 --- a/README.md +++ b/README.md @@ -64,9 +64,9 @@ Every platform has a recommended route below. On Windows that is the Microsoft S ### System requirements -- **Windows**: version 1903+ (build 18362), Intel 8th Gen / AMD Ryzen 2000 series or newer recommended +- **Windows**: version 1903+ (build 18362) with Intel 8th Gen / AMD Ryzen 2000 series or newer minimum; Windows 11 with Intel 12th Gen / Ryzen 4000 series or newer recommended - **macOS**: 12.3 (Monterey) or later — required by ScreenCaptureKit for native capture -- **Linux**: a desktop with `xdg-desktop-portal` and PipeWire (default on Ubuntu 22.04+, Fedora 34+) +- **Linux**: `xdg-desktop-portal` and PipeWire for native capture and system audio; recording still works without them through the browser-capture fallback, with fewer capabilities (see [Platform differences](#platform-differences)) - **RAM**: 8 GB minimum, 16 GB recommended Full table and notes on older integrated graphics: [system requirements](https://getopenscreen.com/docs/installation#system-requirements). diff --git a/website/docs/installation.md b/website/docs/installation.md index 953035dfa..d71f0197c 100644 --- a/website/docs/installation.md +++ b/website/docs/installation.md @@ -24,7 +24,7 @@ Download the latest installer for your platform from the [download page](/downlo |---|---|---| | **Windows** | Windows 10 version 1903 (build 18362) or later, Intel 8th Gen / AMD Ryzen 2000 series or newer | Windows 11, Intel 12th Gen / AMD Ryzen 4000 series or newer | | **macOS** | macOS 12.3 (Monterey) — required by ScreenCaptureKit for native capture | macOS 14 or later | -| **Linux** | A desktop with `xdg-desktop-portal` and PipeWire (default on Ubuntu 22.04+, Fedora 34+) | Same, kept up to date | +| **Linux** | `xdg-desktop-portal` and PipeWire for native capture and system audio (default on Ubuntu 22.04+, Fedora 34+) — recording still works without them through the [browser-capture fallback](#platform-differences), with fewer capabilities | Same, kept up to date | | **RAM** | 8 GB | 16 GB | :::note Older integrated graphics on Windows diff --git a/website/src/pages/download.tsx b/website/src/pages/download.tsx index 1e5ac6001..03f75fd80 100644 --- a/website/src/pages/download.tsx +++ b/website/src/pages/download.tsx @@ -56,7 +56,7 @@ const PLATFORMS: PlatformSpec[] = [ footnote: ( <> System audio is captured without extra drivers. Integrated graphics older than ~8th-gen - Intel may hit known recording-stop issues — see{" "} + Intel (or the AMD Ryzen 2000 series equivalent) may hit known recording-stop issues — see{" "} system requirements. ),