From 14cf6b6088e26633076cd9fcda75ac3810372cf3 Mon Sep 17 00:00:00 2001 From: Storm Dragon Date: Sun, 11 Jan 2026 23:15:28 -0500 Subject: [PATCH] Clarify other OS than Linux support. --- README.md | 17 ++++++++++------- src/fenrirscreenreader/fenrirVersion.py | 2 +- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 46eb6f81..80d28017 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Fenrir -A modern, modular, flexible and fast console screen reader. -It should run on any operating system. If you want to help, or write drivers to make it work on other systems, just let me know. +A modern, modular, flexible and fast console screen reader for Linux. This software is licensed under the LGPL v3. **Current maintainer:** Storm Dragon @@ -24,12 +23,16 @@ This software is licensed under the LGPL v3. - **Tutorial Mode**: Built-in help system for learning keyboard shortcuts -## OS Requirements +## Platform Support -- Linux (ptyDriver, vcsaDriver, evdevDriver) - Primary platform with full support -- macOS (ptyDriver) - Limited support -- BSD (ptyDriver) - Limited support -- Windows (ptyDriver) - Limited support +Fenrir is a Linux screen reader. Linux is the only officially supported platform. + +**Other platforms (macOS, BSD, Windows):** Pull requests adding support for other operating systems may be accepted provided they do not break Linux functionality. However, no special care will be taken to preserve functionality on secondary platforms. If changes to Fenrir break support on a non-Linux OS, it is the responsibility of third-party contributors to submit fixes. + +- Linux (ptyDriver, vcsaDriver, evdevDriver) - Full support +- macOS (ptyDriver) - Community-maintained, no guarantees +- BSD (ptyDriver) - Community-maintained, no guarantees +- Windows (ptyDriver) - Community-maintained, no guarantees ## Core Requirements diff --git a/src/fenrirscreenreader/fenrirVersion.py b/src/fenrirscreenreader/fenrirVersion.py index 37237eb1..37cd38ca 100644 --- a/src/fenrirscreenreader/fenrirVersion.py +++ b/src/fenrirscreenreader/fenrirVersion.py @@ -4,5 +4,5 @@ # Fenrir TTY screen reader # By Chrys, Storm Dragon, and contributors. -version = "2026.01.10" +version = "2026.01.11" code_name = "testing"