Clarify desktop documentation and simplify project presentation

This commit is contained in:
Samuel Onoja committed 2026-10-13 03:15:00 +01:00
1 parent b552288dc1
commit f57c68454a
6 files changed
+81 -99

No files matched your search

+5
View File
@@ -1,5 +1,10 @@
# Documentation
These guides describe the development version on `main`.
For the packaged **0.1.0-beta**, use the
[release notes](https://github.com/ferese-wm/ferese/releases/tag/v0.1.0-beta)
and [guides at that tag](https://github.com/ferese-wm/ferese/tree/v0.1.0-beta/docs).
## Usage
- [Installation](installation.md): install dependencies, log in, preview changes, update and recover a session.
+7 -2
View File
@@ -3,8 +3,13 @@
Ferese runs on Linux as its own Wayland session alongside your existing desktop.
Launch it from a login manager, a command-based greeter or a local TTY.
For Fedora and Arch packages, see [Packages and releases](packaging.md). The
steps below build and install from source.
The [0.1.0-beta release](https://github.com/ferese-wm/ferese/releases/tag/v0.1.0-beta)
has packages for Fedora 44 and Arch Linux on x86_64. Follow
[package installation](packaging.md#install-a-release-package) to use those builds.
The steps below build the development version from `main`. It includes tabbed
window groups, binding modes, Live Activities, new panel styles, and audio and
region recording added since the beta. The wiki describes this development version.
## Requirements
+3 -3
View File
@@ -2,7 +2,7 @@
Alongside a window manager, you need Wi-Fi, audio and display controls, notifications and a lock screen. You can choose these components separately, but keeping their settings and behaviour consistent takes extra work.
Ferese includes a Wayland compositor, desktop shell, Settings, Control Center and a lock screen with shared configuration and theming. It keeps window management configurable while defining how a desktop change applies across those components.
Ferese includes a Wayland compositor, desktop shell, Settings, Control Center and a lock screen with shared configuration and theming. You can choose a window layout per workspace and change desktop settings through the GUI or a KDL file.
## Settings that apply beyond one component
@@ -32,6 +32,6 @@ Continuum, Ferese’s shared motion system, keeps a moving value’s current pos
A window’s content, clipping and border need to follow the same presented bounds. When the application closes, its live surface may disappear before the visual exit finishes, so Ferese retains an image for that transition. Shell content and its compositor-drawn material also need to leave together, or the text can disappear while its background or blur remains.
## Testing the whole interaction
## Testing on hardware
Resize coordination, output timing and interrupted transitions need testing and measurements on the hardware where the desktop runs.
Resize coordination, output timing and interrupted transitions need testing and measurements on the hardware where the desktop runs. The [output management checks](output-management-testing.md) cover hotplug and display changes. Use the [nested resize checks](nested-resize-testing.md) for window resizing and the [client soak tests](native-soak-testing.md) for repeated window creation and cleanup.