From 23abeca651c8bf3bacdba2266be2664382fc33a5 Mon Sep 17 00:00:00 2001 From: Storm Dragon Date: Fri, 10 Apr 2026 19:03:43 -0400 Subject: [PATCH] docs: clarify current fork maintenance --- README-DEVELOPMENT.md | 4 ++++ README-REMOTE-CONTROLLER.md | 5 +++++ README.md | 17 ++++++++++++++++- REMOTE-CONTROLLER-COMMANDS.md | 5 +++++ cthulhu.doap | 12 ++---------- distro-packages/Slint/README | 8 ++++++-- docs/man/cthulhu.1 | 12 ++++++++---- 7 files changed, 46 insertions(+), 17 deletions(-) diff --git a/README-DEVELOPMENT.md b/README-DEVELOPMENT.md index 72f33b2..6571e6c 100644 --- a/README-DEVELOPMENT.md +++ b/README-DEVELOPMENT.md @@ -1,5 +1,9 @@ # Cthulhu Development Guide +This document applies to the Cthulhu fork maintained by Storm Dragon. +Cthulhu is forked from Orca; prior Orca maintainers and contributors are part +of the upstream history, but they are not current maintainers of this fork. + ## Local Development Build To develop Cthulhu without overwriting your system installation, use the provided build scripts: diff --git a/README-REMOTE-CONTROLLER.md b/README-REMOTE-CONTROLLER.md index a9b2356..320d4be 100644 --- a/README-REMOTE-CONTROLLER.md +++ b/README-REMOTE-CONTROLLER.md @@ -1,5 +1,10 @@ # Cthulhu Remote Controller (D-Bus Interface) +This documentation covers the Cthulhu fork maintained by Storm Dragon. +Cthulhu is forked from Orca; former Orca maintainers and contributors are part +of the project's upstream history, but they are not current maintainers of +this fork. + > **⚠️⚠️ WORK IN PROGRESS**: This D-Bus interface is brand new and not yet feature complete. Low-risk feature additions will continue to be made. The API may be modified beyond bug fixes in future versions based on feedback from consumers of this support. diff --git a/README.md b/README.md index 205da46..54b5b8c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,22 @@ ## Note -Cthulhu is a fork of the Orca screen reader. Project home: https://git.stormux.org/storm/cthulhu. Cthulhu is currently a supplemental screen reader that fills a nitch for some advanced users. E.g. some older QT based programs may work with Cthulhu, and if you use certain window managers like i3, Mozilla applications like Firefox and Thunderbird may work better. +Cthulhu is a fork of the Orca screen reader. Project home: https://git.stormux.org/storm/cthulhu. Cthulhu is currently a supplemental screen reader that fills a niche for some advanced users. For example, some older Qt-based programs may work with Cthulhu, and if you use certain window managers like i3, Mozilla applications like Firefox and Thunderbird may work better. + +## Current Maintenance + +Cthulhu is currently maintained by Storm Dragon. + +Current contributors called out in this fork's documentation: + +- Hunter Joziak +- Harley Richardson (`destructatron`) + +## Project History + +Cthulhu is forked from Orca and builds on many years of upstream work by the Orca community, including former maintainers and contributors such as Joanmarie Diggs and others. + +Those upstream maintainers and contributors are part of the project's history, but they are not current maintainers of this fork unless explicitly noted elsewhere. ## Introduction diff --git a/REMOTE-CONTROLLER-COMMANDS.md b/REMOTE-CONTROLLER-COMMANDS.md index bf0a5a6..4e481b6 100644 --- a/REMOTE-CONTROLLER-COMMANDS.md +++ b/REMOTE-CONTROLLER-COMMANDS.md @@ -1,5 +1,10 @@ # Cthulhu Remote Controller - Available Commands +This documentation covers the Cthulhu fork maintained by Storm Dragon. +Cthulhu is forked from Orca; former Orca maintainers and contributors are part +of the project's upstream history, but they are not current maintainers of +this fork. + This document lists the currently available D-Bus commands in Cthulhu's Remote Controller interface. > **Note**: This is a work-in-progress. As more modules are exposed via D-Bus, this document will be expanded. Eventually this will be auto-generated using `tools/generate_dbus_documentation.py`. diff --git a/cthulhu.doap b/cthulhu.doap index fcdc304..8e9c05d 100644 --- a/cthulhu.doap +++ b/cthulhu.doap @@ -15,16 +15,8 @@ Python - Joanmarie Diggs - - joanied - - - - - Federico Mena Quintero - - federico + Storm Dragon + diff --git a/distro-packages/Slint/README b/distro-packages/Slint/README index 1825ead..319b02f 100644 --- a/distro-packages/Slint/README +++ b/distro-packages/Slint/README @@ -1,11 +1,15 @@ Cthulhu is a screen reader for individuals who are blind or visually impaired, forked from Orca. It provides access to applications and toolkits that support -the AT-SPI (e.g., the GNOME desktop). +the AT-SPI (e.g., GNOME and other Linux desktop environments). + +This fork is currently maintained by Storm Dragon. It builds on upstream Orca +work, but former Orca maintainers and contributors are not current maintainers +of this fork. This screen reader helps users navigate their desktop environment and applications through speech synthesis and braille output. -After installation, you can start Cthulhu through the GNOME desktop environment +After installation, you can start Cthulhu through your desktop environment or by running 'cthulhu' from the command line. DEPENDENCIES: diff --git a/docs/man/cthulhu.1 b/docs/man/cthulhu.1 index b66f9dd..d080880 100644 --- a/docs/man/cthulhu.1 +++ b/docs/man/cthulhu.1 @@ -14,7 +14,7 @@ .\" along with this; if not write to the Free Software Foundation, Inc. .\" 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA '\" -.TH cthulhu 1 "20 September 2013" "GNOME" +.TH cthulhu 1 "10 April 2026" "Stormux" .SH NAME cthulhu \- a scriptable screen reader .SH SYNOPSIS @@ -26,13 +26,17 @@ is a screen reader for people with visual impairments, it provides alternative access to the desktop by using speech synthesis and braille. .P .B cthulhu +is maintained in this fork by Storm Dragon. It is forked from Orca and builds +on upstream work by former Orca maintainers and contributors, who are part of +the project's history but are not current maintainers of this fork. +.P +.B cthulhu works with applications and toolkits that support the Assistive Technology Service Provider Interface (AT-SPI), which is the primary assistive technology infrastructure for Linux and Solaris. Applications and toolkits supporting the AT-SPI include the GNOME Gtk+ toolkit, the Java platform's Swing toolkit, LibreOffice, -Gecko, and WebKitGtk. AT-SPI support for the KDE Qt toolkit is being -pursued. +Gecko, WebKitGtk, and the KDE Qt toolkit. .SH OPTIONS .TP .B \-s, --setup @@ -121,7 +125,7 @@ in desktop keyboard layout and in laptop keyboard layout. .B Cthulhu -uses default GNOME keyboard shortcuts to navigate the desktop and interact with various applications. The flat review commands provide an alternative method of interaction in certain inaccessible applications. It should not be confused with flat review functionality provided by other screen readers. +uses its configured keyboard shortcuts to navigate the desktop and interact with various applications. The flat review commands provide an alternative method of interaction in certain inaccessible applications. It should not be confused with flat review functionality provided by other screen readers. .SH Desktop Mode