Samuel Onoja
1b9fabbbe4
* Package Ferese for Fedora and Arch releases * Build release packages alongside workspace checks * Include dependency licenses and software GPU test drivers * Limit package checks to release PRs and fix Arch Cargo dependency * Prepare Ferese 0.1.0-beta * Release config locks before closing inherited file descriptions * Install the lock PAM policy for native release checks * Include xauth in distribution package test dependencies * Regenerate Arch Git package metadata * Run package checks with an explicit UTC timezone * Remove unused bundled fonts and accept installed license receipts * Format the system font test helper * Load an installed font for headless text rendering checks * Isolate package test runtimes and reap container child processes
123 lines
7.0 KiB
Markdown
123 lines
7.0 KiB
Markdown
<p align="center">
|
||
<img src="assets/branding/ferese.svg" width="160" height="160" alt="Ferese">
|
||
</p>
|
||
|
||
<p align="center"><strong>A configurable Wayland desktop</strong></p>
|
||
|
||
<p align="center">
|
||
<a href="docs/installation.md">Install</a> ·
|
||
<a href="docs/configuration.md">Configure</a> ·
|
||
<a href="docs/screenshots.md">Screenshots</a> ·
|
||
<a href="docs/README.md">Documentation</a>
|
||
</p>
|
||
|
||
Ferese combines a window manager and desktop shell with one configuration.
|
||
|
||
|
||
|
||
[View more screenshots](docs/screenshots.md)
|
||
|
||
## Features
|
||
|
||
- Scrolling columns, window groups, tree tiling and floating windows with saved size and position
|
||
- Integrated shell with notifications, media controls, Settings and Control Center
|
||
- [Custom panels](docs/configuration.md#panel-composition) with editable items, groups, surfaces, and top or bottom placement
|
||
- Workspace overview and recent-window switching
|
||
- [Continuum animations](docs/configuration.md#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](docs/configuration.md#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](docs/animation-model.md): 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.
|
||
|
||
## Install
|
||
|
||
Fedora and Arch package builds are covered in [Packages and releases](docs/packaging.md).
|
||
|
||
Start with the [dependencies](docs/installation.md#requirements), then clone Ferese and
|
||
build it as your normal user:
|
||
|
||
```sh
|
||
git clone https://github.com/ferese-wm/ferese.git
|
||
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](docs/installation.md) also walks you through previews, updates and recovery.
|
||
|
||
## Configure
|
||
|
||
Configure Ferese through **Control Center → Settings** or `~/.config/ferese/config.kdl`.
|
||
Changes apply live. Invalid edits leave the last working configuration in place.
|
||
|
||
The [configuration reference](docs/configuration.md) and [example
|
||
config](packaging/config.kdl) cover appearance, window layouts,
|
||
displays and startup apps.
|
||
|
||
## 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.
|
||
|
||
| 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](docs/shortcuts.md) for window and workspace controls.
|
||
|
||
## Documentation
|
||
|
||
The [documentation index](docs/README.md) lists the desktop guides.
|
||
[Development instructions](docs/development.md) 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.
|