Clarify desktop documentation and simplify project presentation

README.md

@@ -5,66 +5,54 @@
 <p align="center"><strong>A configurable Wayland desktop</strong></p>
 
 <p align="center">
+  <a href="https://github.com/ferese-wm/ferese/releases">Download</a> ·
   <a href="https://github.com/ferese-wm/ferese/wiki/Installation">Install</a> ·
   <a href="https://github.com/ferese-wm/ferese/wiki/Configuration">Configure</a> ·
-  <a href="https://github.com/ferese-wm/ferese/wiki/Screenshots">Screenshots</a> ·
   <a href="https://github.com/ferese-wm/ferese/wiki">Documentation</a>
 </p>
 
-Ferese combines a window manager and desktop shell with one configuration.
+Ferese is a Linux desktop built in Rust with Smithay. It includes a window manager,
+desktop shell, Settings and a lock screen, with shared configuration and theming.
+Choose a layout per workspace and configure the desktop through Settings or a KDL file.
+
+**Beta:** [0.1.0-beta](https://github.com/ferese-wm/ferese/releases/tag/v0.1.0-beta)
+has packages for Fedora 44 and Arch Linux on x86_64. This README and the wiki
+describe `main`.
 
 https://github.com/user-attachments/assets/681f0748-8813-4e2d-b3cc-28a3dc5b3c64
 
-[Watch the full demo at 2× speed](https://ferese-wm.github.io/ferese/#desktop-preview)
+[Full demo at 2× speed](https://ferese-wm.github.io/ferese/#desktop-preview) ·
+[Screenshots](https://github.com/ferese-wm/ferese/wiki/Screenshots)
 
-[View more screenshots](https://github.com/ferese-wm/ferese/wiki/Screenshots)
+## Using Ferese
 
-## Features
+- Use scrolling columns, tree tiling, floating windows and
+  [tabbed window groups](https://github.com/ferese-wm/ferese/wiki/Tabbed-Windows).
+- Arrange [panel items and groups](https://github.com/ferese-wm/ferese/wiki/Panel-Configuration),
+  place the panel at the top or bottom, and choose its style.
+- Follow command and build progress in the panel with
+  [Live Activities](https://github.com/ferese-wm/ferese/wiki/Live-Activities).
+- Set up [binding modes](https://github.com/ferese-wm/ferese/wiki/Configuration-Bindings#binding-modes)
+  for resizing, launching apps and other shortcut groups.
+- Change themes, wallpapers, blur and animation settings across the desktop.
+  Configuration edits apply live. Invalid edits leave the last working configuration active.
+- Manage displays, Wi-Fi, Bluetooth and audio from Settings and Control Center.
+  Multiple monitors, fractional scaling and monitor mirroring are supported.
+- Annotate screenshots, share a window or display, and record a monitor or selected
+  region with audio.
 
-- Scrolling columns, [tabbed window groups](https://github.com/ferese-wm/ferese/wiki/Tabbed-Windows), tree tiling and floating windows with saved size and position
-- Integrated shell with notifications, media controls, Settings and Control Center
-- [Custom panels](https://github.com/ferese-wm/ferese/wiki/Panel-Configuration) with seven styles, editable groups and items, and top or bottom placement
-- [Live Activities](https://github.com/ferese-wm/ferese/wiki/Live-Activities) for build status, running commands and progress from connected apps
-- Workspace overview and recent-window switching
-- [Continuum animations](https://github.com/ferese-wm/ferese/wiki/Configuration-Animations): interruptible springs, gesture momentum and shared motion controls
-- Live wallpapers and blur, custom KDL themes, and Light/Dark/Auto modes
-- Multiple monitors, fractional scaling and lower refresh rates on low battery
-- Wi-Fi, Bluetooth and audio controls
-- Custom keyboard shortcuts and touchpad gestures
-- Screenshot annotation, screen sharing and recording
-- Lock screen and authentication dialogs
-- [Keep awake](https://github.com/ferese-wm/ferese/wiki/Configuration-Idle-Inhibition) during fullscreen media playback or for selected apps
-- Continuous corners for windows and shell
-
-## How Ferese compares
-
-Ferese combines scrolling and tree layouts with its own desktop controls. The table
-compares current upstream features and names separate tools where they are needed.
-
-| Feature | Ferese | [Hyprland](https://github.com/hyprwm/Hyprland) | [niri](https://github.com/niri-wm/niri) |
-| --- | --- | --- | --- |
-| Tiling layouts | Scrolling columns and tree tiling; switch per workspace | [Scrolling, dwindle, master and monocle; per-workspace layouts](https://github.com/hyprwm/Hyprland#features) | Scrolling columns |
-| Floating windows | Built in | Built in | Built in |
-| Workspace overview | Built in | Plugins such as [HyprExpo](https://github.com/sandwichfarm/hyprexpo) | Built in |
-| Animations | [Continuum](https://github.com/ferese-wm/ferese/wiki/Animation-Model): interruptible springs, gesture momentum; speed and reduced-motion settings shared by the compositor and shell | Bézier and spring curves | [Spring and easing animations; custom shaders](https://niri-wm.github.io/niri/Configuration:-Animations.html) |
-| Corner shapes | Continuous corners across windows and shell | [Rounded corners and squircles](https://wiki.hypr.land/configuring/core/config-options/#decoration) | [Rounded corners with optional clipping](https://niri-wm.github.io/niri/Configuration:-Window-Rules.html#geometry-corner-radius) |
-| Live configuration reload | Yes | Yes | Yes |
-| Monitor mirroring | Built in | [Built in](https://wiki.hypr.land/configuring/core/monitors/) | Separate tool, such as [wl-mirror](https://niri-wm.github.io/niri/Screencasting.html#screen-mirroring) |
-| Desktop controls | Included Settings and Control Center | [Separate utilities](https://wiki.hypr.land/hypr-ecosystem/) or a desktop shell | [Separate desktop shell or tools](https://niri-wm.github.io/niri/Integrating-niri.html#desktop-components) |
-| Notifications | Included in ferese-shell | [Separate notification daemon](https://wiki.hypr.land/Useful-Utilities/Must-have/) | [Separate notification daemon or shell](https://niri-wm.github.io/niri/Integrating-niri.html) |
-| Lock screen | Included ferese-lock | Separate [hyprlock](https://wiki.hypr.land/Hypr-Ecosystem/hyprlock/) | Separate locker, such as [swaylock or hyprlock](https://niri-wm.github.io/niri/Integrating-niri.html) |
-| Screen-sharing backend | xdg-desktop-portal-ferese | [xdg-desktop-portal-hyprland](https://wiki.hypr.land/Hypr-Ecosystem/xdg-desktop-portal-hyprland/) | [xdg-desktop-portal-gnome](https://niri-wm.github.io/niri/Screencasting.html#overview) |
-
-Ferese's shell, Settings, lock screen and dialogs use a shared theme. Other desktop
-shells, including [DankMaterialShell and Noctalia](https://niri-wm.github.io/niri/Integrating-niri.html#desktop-components),
-also include desktop controls; their features depend on the shell and tools you install.
+The [feature roadmap](https://github.com/ferese-wm/ferese/issues/5) tracks implemented features and remaining work.
 
 ## Install
 
-Fedora and Arch package builds are covered in [Packages and releases](https://github.com/ferese-wm/ferese/wiki/Packages-and-Releases).
+Download the package for your distribution from
+[Releases](https://github.com/ferese-wm/ferese/releases/tag/v0.1.0-beta), then follow
+the [package installation instructions](https://github.com/ferese-wm/ferese/wiki/Packages-and-Releases#install-a-release-package).
+The release notes list the beta's limitations.
 
-Start with the [dependencies](https://github.com/ferese-wm/ferese/wiki/Installation#requirements), then clone Ferese and
-build it as your normal user:
+To build the current development version, install the
+[build dependencies](https://github.com/ferese-wm/ferese/wiki/Installation#requirements)
+and run these commands as your normal user:
 
 ```sh
 git clone https://github.com/ferese-wm/ferese.git
@@ -72,55 +60,36 @@ cd ferese
 ./scripts/install.sh
 ```
 
-Once it’s installed, log out and choose **Ferese** at your login screen, or run
-`ferese-session` from a TTY or a greeter that accepts a command. The [installation
-guide](https://github.com/ferese-wm/ferese/wiki/Installation) also walks you through previews, updates and recovery.
+Once installed, log out and select **Ferese** at your login screen, or run
+`ferese-session` from a local TTY. You can also try a
+[nested preview](https://github.com/ferese-wm/ferese/wiki/Installation#preview-and-logs)
+inside your existing Wayland desktop.
 
 ## Configure
 
-Configure Ferese through **Control Center → Settings** or `~/.config/ferese/config.kdl`.
-Changes apply live, and if an edit is invalid, the last working configuration stays
-in place.
+Open **Control Center → Settings** or edit `~/.config/ferese/config.kdl`.
+The [configuration reference](https://github.com/ferese-wm/ferese/wiki/Configuration)
+and [example config](packaging/config.kdl) cover appearance, layouts, displays,
+window rules and startup apps.
 
-The [configuration reference](https://github.com/ferese-wm/ferese/wiki/Configuration) and [example
-config](packaging/config.kdl) cover appearance, window layouts,
-displays and startup apps.
+## First shortcuts
 
-## Default shortcuts
-
-Use `Super`, usually the Windows key, to move around your desktop, and open **Settings →
-Shortcuts** whenever you want to change a shortcut or gesture.
+`Super` is usually the Windows key. Change shortcuts and gestures in **Settings → Shortcuts**.
 
 | Control | Action |
 | --- | --- |
 | Super + Enter | Open a terminal |
-| Display Fn key (`XF86Display`) | Choose the display mode |
-| Media Play / Pause, Next, Previous | Control the selected MPRIS player |
 | Super + H / J / K / L | Focus left / down / up / right |
-| Super + Backspace | Return to the last focused window |
-| Super + Escape | Toggle between the last two visited workspaces on this monitor |
-| Alt + Tab / Alt + Shift + Tab | Preview recent windows forward / backward; release Alt to select, Escape to cancel |
-| Super + F | Maximize the window |
-| Super + Shift + F | Toggle fullscreen |
-| Super + R | Cycle column width |
 | Super + Tab | Open overview |
 | Super + M | Switch scrolling / tree layout |
-| Print Screen | Capture the active monitor and open Satty |
-| Super + Shift + S | Select a screenshot area |
 | Super + Shift + E | Ask to log out |
-| Super + left-button drag | Move a floating window |
-| Super + right-button drag | Resize a floating window |
-| Three-finger swipe up / down | Next / previous workspace |
-| Three-finger swipe left / right | Focus the window to the right / left |
 
-See [all shortcuts and mouse actions](https://github.com/ferese-wm/ferese/wiki/Shortcuts-and-Gestures) for window and workspace controls.
+See [all shortcuts and gestures](https://github.com/ferese-wm/ferese/wiki/Shortcuts-and-Gestures)
+for resizing, grouping windows, screenshots and workspace navigation.
 
-## Documentation
+## Development and bug reports
 
-The [documentation index](https://github.com/ferese-wm/ferese/wiki) lists the desktop guides.
-[Development instructions](https://github.com/ferese-wm/ferese/wiki/Development) cover building, testing and contributing.
-
-Ferese is written in Rust using Smithay. Development happens [on
-GitHub](https://github.com/ferese-wm/ferese). If something goes wrong, [open an
-issue](https://github.com/ferese-wm/ferese/issues) with the steps to reproduce it and
-any relevant logs.
+[Development instructions](https://github.com/ferese-wm/ferese/wiki/Development)
+cover building, tests and hardware checks. To
+[report a bug](https://github.com/ferese-wm/ferese/issues), include steps to reproduce it,
+your version or commit, relevant logs, and whether you ran a nested preview or a direct session.

docs/README.md

@@ -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.

docs/installation.md

@@ -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
 

docs/why-ferese.md

@@ -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.

site/home.css

@@ -1,6 +1,8 @@
 .hero { text-align: center; padding-top: 64px; }
 h1 { font-size: clamp(45px, 6.1vw, 80px); font-weight: 590; letter-spacing: -.055em; line-height: 1.08; margin: 0; text-wrap: balance; }
 .hero-description { font-size: 18px; line-height: 1.6; max-width: 555px; margin: 22px auto 0; color: var(--muted); text-wrap: balance; }
+.release-note { max-width: 555px; margin: 16px auto 0; color: var(--muted); font-size: 13px; line-height: 1.65; text-wrap: balance; }
+.release-note a { color: var(--ink); text-decoration: underline; text-underline-offset: 3px; }
 .hero-actions { display: flex; align-items: center; justify-content: center; gap: 28px; margin-top: 27px; }
 .primary-button { display: inline-flex; align-items: center; gap: 16px; background: var(--button); color: #fff; padding: 13px 22px; border-radius: 30px; font-size: 13px; font-weight: 500; transition: background .2s; }
 .primary-button .icon { width: 17px; height: 17px; }

site/index.html

@@ -4,15 +4,15 @@
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <meta name="theme-color" content="#111821">
-  <meta name="description" content="Ferese is a configurable Wayland desktop for Linux. Explore its window layouts, shared themes, and editable panel.">
-  <meta property="og:title" content="Ferese — A little more room.">
-  <meta property="og:description" content="A configurable Wayland desktop for Linux that brings your windows and everyday controls together.">
+  <meta name="description" content="Ferese is a Wayland desktop for Linux with scrolling and tree tiling, an included shell, and shared configuration. Beta packages for Fedora and Arch Linux.">
+  <meta property="og:title" content="Ferese | A configurable Wayland desktop">
+  <meta property="og:description" content="Scrolling and tree tiling with an included desktop shell, Settings and lock screen. Beta packages for Fedora and Arch Linux.">
   <meta property="og:type" content="website">
   <meta property="og:image" content="https://ferese-wm.github.io/ferese/assets/videos/ferese-demo-poster.webp">
   <meta property="og:image:width" content="2880">
   <meta property="og:image:height" content="1800">
   <meta name="twitter:card" content="summary_large_image">
-  <title>Ferese — A little more room.</title>
+  <title>Ferese | A configurable Wayland desktop</title>
   <link rel="icon" href="assets/branding/ferese.svg" type="image/svg+xml">
   <link rel="icon" href="assets/favicon.ico" sizes="16x16 32x32 48x48">
   <link rel="icon" href="assets/favicon-32.png" type="image/png" sizes="32x32">
@@ -35,8 +35,9 @@
   </header>
   <main id="main">
     <section class="hero page-width" aria-labelledby="hero-title">
-      <h1 id="hero-title">A little more room.</h1>
-      <p class="hero-description">A configurable Wayland desktop for Linux that brings your windows and everyday controls together.</p>
+      <h1 id="hero-title">A configurable Wayland desktop.</h1>
+      <p class="hero-description">Ferese is a Wayland desktop for Linux with an included shell, Settings and lock screen. Choose a layout per workspace and configure it all in Settings or a KDL file.</p>
+      <p class="release-note"><a href="https://github.com/ferese-wm/ferese/releases/tag/v0.1.0-beta">0.1.0-beta</a> is available for Fedora 44 and Arch Linux on x86_64. This page and the wiki describe the development version.</p>
       <div class="hero-actions"><a class="primary-button" href="https://github.com/ferese-wm/ferese/wiki/Installation">Get Ferese <svg class="icon"><use href="#i-arrow"/></svg></a><a class="inline-link" href="#desktop-preview">Take a look <svg class="icon down"><use href="#i-arrow"/></svg></a></div>
       <div class="desktop-stage" id="desktop-preview">
         <div class="desktop-capture" id="desktop-capture">
@@ -48,26 +49,26 @@
       </div>
     </section>
     <section class="layout-section page-width" id="make-room" aria-labelledby="layout-title">
-      <div class="section-heading"><h2 id="layout-title">Space for the way<br>you think.</h2><p>Let your windows scroll into place, or share the screen in a tree layout. Open Overview to see your workspaces and find the window you need.</p></div>
+      <div class="section-heading"><h2 id="layout-title">Choose a layout<br>per workspace.</h2><p>Scroll through columns of windows, or divide the screen with tree tiling. Floating windows remember their size and position. Open Overview to find a window across your workspaces.</p></div>
       <figure class="feature-capture overview-capture">
         <a href="assets/screenshots/ferese-overview.webp" target="_blank" rel="noopener" aria-label="View the Overview screenshot at full resolution"><img src="assets/screenshots/ferese-overview-1440.webp" srcset="assets/screenshots/ferese-overview-960.webp 960w, assets/screenshots/ferese-overview-1440.webp 1440w, assets/screenshots/ferese-overview.webp 2880w" sizes="(max-width: 700px) calc(100vw - 40px), (max-width: 1200px) calc(100vw - 80px), 1120px" width="2880" height="1800" alt="Ferese Overview showing three workspaces and open terminal and reading windows over the city wallpaper." loading="lazy" decoding="async"></a>
-        <figcaption>Every workspace, in view.</figcaption>
+        <figcaption>Overview with open windows and three workspace previews.</figcaption>
       </figure>
     </section>
     <section class="appearance-section" id="appearance" aria-labelledby="appearance-title"><div class="page-width">
-      <div class="centered-heading"><h2 id="appearance-title">One look. Everywhere.</h2><p>Choose your colours and shape your panel. A shared theme brings every part of Ferese together.</p></div>
+      <div class="centered-heading"><h2 id="appearance-title">Change the desktop theme.</h2><p>Set colours, fonts and corner shapes for the shell, Settings and lock screen. Theme changes apply live.</p></div>
     </div></section>
     <section class="details-section page-width" aria-label="Panel and media features">
       <article class="detail-feature">
-        <h3>Your panel, your way.</h3><p>Arrange items in groups, choose their surfaces, and put your panel at the top or bottom of the screen.</p>
+        <h3>Arrange your panel.</h3><p>Arrange items in groups, choose their surfaces, and put your panel at the top or bottom of the screen. New panel styles are available in the development version.</p>
       </article>
       <article class="detail-feature">
-        <h3>A little closer to your music.</h3><p>See what's playing and pause or skip a track, right from your panel.</p>
+        <h3>Control playback from the panel.</h3><p>See what's playing and pause or skip a track, right from your panel.</p>
       </article>
     </section>
     <div class="gallery-link page-width"><a class="inline-link" href="https://github.com/ferese-wm/ferese/wiki/Screenshots">See all desktop screenshots <svg class="icon"><use href="#i-arrow"/></svg></a></div>
-    <section class="start-section page-width" aria-labelledby="start-title"><img class="start-logo" src="assets/branding/ferese.svg" width="74" height="74" alt=""><h2 id="start-title">Make yourself at home.</h2><p>Try Ferese in a nested session, or install it as your next desktop.</p><div class="hero-actions"><a class="primary-button" href="https://github.com/ferese-wm/ferese/wiki/Installation">Get Ferese <svg class="icon"><use href="#i-arrow"/></svg></a><a class="inline-link" href="https://github.com/ferese-wm/ferese">Explore the source <svg class="icon"><use href="#i-external"/></svg></a></div></section>
+    <section class="start-section page-width" aria-labelledby="start-title"><img class="start-logo" src="assets/branding/ferese.svg" width="74" height="74" alt=""><h2 id="start-title">Try Ferese.</h2><p>Download the beta for Fedora 44 or Arch Linux, or build from source for the latest changes. You can preview Ferese inside an existing Wayland session.</p><div class="hero-actions"><a class="primary-button" href="https://github.com/ferese-wm/ferese/releases/tag/v0.1.0-beta">Download the beta <svg class="icon"><use href="#i-arrow"/></svg></a><a class="inline-link" href="https://github.com/ferese-wm/ferese/wiki/Installation">Build and preview <svg class="icon"><use href="#i-external"/></svg></a></div></section>
   </main>
-  <footer class="site-footer page-width"><a class="brand" href="#main" aria-label="Ferese home"><img src="assets/branding/ferese.svg" width="28" height="28" alt=""><span>Ferese</span></a><span>Built in the open for Linux.</span><nav aria-label="Footer navigation"><a href="https://github.com/ferese-wm/ferese/wiki">Documentation</a><a href="https://github.com/ferese-wm/ferese">GitHub <svg class="icon"><use href="#i-external"/></svg></a></nav></footer>
+  <footer class="site-footer page-width"><a class="brand" href="#main" aria-label="Ferese home"><img src="assets/branding/ferese.svg" width="28" height="28" alt=""><span>Ferese</span></a><span>Rust and Smithay · MIT license</span><nav aria-label="Footer navigation"><a href="https://github.com/ferese-wm/ferese/wiki">Documentation</a><a href="https://github.com/ferese-wm/ferese">GitHub <svg class="icon"><use href="#i-external"/></svg></a></nav></footer>
 </body>
 </html>