Prepare stable 0.1.0 release

This commit is contained in:
Samuel Onoja committed 2026-10-25 16:35:51 +01:00
1 parent e03d491353
commit f21167e1a2
10 files changed
+118 -42

No files matched your search

+2 -3
View File
@@ -1,9 +1,8 @@
# 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).
For **0.1.0**, use the [release notes](https://github.com/ferese-wm/ferese/releases/tag/v0.1.0) and
[guides at the release tag](https://github.com/ferese-wm/ferese/tree/v0.1.0/docs).
## Usage
+4 -5
View File
@@ -3,17 +3,16 @@
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.
The [0.1.0-beta release](https://github.com/ferese-wm/ferese/releases/tag/v0.1.0-beta)
The [0.1.0 release](https://github.com/ferese-wm/ferese/releases/tag/v0.1.0)
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.
The steps below build from `main`, which may include changes made after the
release. The wiki follows `main` too.
## Requirements
For a full session, you’ll need a Wayland-capable graphics driver and a local user
For a full session, you'll need a Wayland-capable graphics driver and a local user
session with seat access through logind or seatd. A nested preview runs inside your
existing Wayland desktop.
+4 -3
View File
@@ -89,12 +89,13 @@ release package. Submit that recipe to AUR separately if you want AUR distributi
## Publish a release
1. Set `workspace.package.version` in `Cargo.toml` and update `Cargo.lock`.
2. Commit the release changes and push them.
2. Write `docs/releases/v<version>.md`. The workflow uses this file as the release
notes. Commit the release changes and push them.
3. Tag that commit with the same version, prefixed by `v`, then push the tag:
```sh
git tag v0.1.0-beta
git push origin v0.1.0-beta
git tag v0.1.0
git push origin v0.1.0
```
A tag/version mismatch fails before packaging. Tags with a prerelease suffix,
+60
View File
@@ -0,0 +1,60 @@
# Ferese 0.1.0
Ferese 0.1.0 is our first stable release. It includes the window manager, panel,
Settings, notifications and lock screen, with one set of appearance settings
across the desktop.
## Arrange your windows
Choose a layout for each workspace. Scroll through columns of windows, tile them
to fit the screen, or let them float. You can switch layouts as your work changes
and group related windows into tabs.
Move and resize windows with the mouse or keyboard. Overview shows your open
windows and workspaces, and the launcher finds apps, files and commands.
Display scaling has finer steps for getting text to a comfortable size.
## Change the panel and appearance
Build your panel in Settings. Move controls between groups, put the panel at the
top or bottom, and choose anything from a full-width bar to separate floating
controls. Morph keeps the panel in a small hub that opens when you need it.
Pick from six themes with light and dark versions, then adjust the colors,
wallpaper, transparency and motion. The shell, Settings, menus and lock screen
follow the same theme. Changes apply as you make them.
The panel can also show command and build progress, music controls, and a focus
timer with work and break sessions.
## Share and record
Share a window, a display, or one workspace. A shared workspace stays on screen
for your audience when you switch elsewhere, and leaves out the panel and
notifications. Sharing ends when you lock the desktop.
Record a display or a selected area from the panel, with optional microphone
and system audio. The new **Capture status** item shows which apps are sharing.
With the optional OBS connection set up, it also shows when you're live,
recording, paused or reconnecting. An OBS preview alone shows **Sharing**.
Your saved panel layout stays as it is. To add the new indicator, open
**Settings → Panel & Shell → Edit panel → Add item** and choose **Capture status**.
The [sharing guide](https://github.com/ferese-wm/ferese/blob/v0.1.0/docs/screen-sharing.md#panel-status)
includes the OBS setup steps.
We removed repeated background checks and work that redraws an unchanged screen.
Fixes also cover floating windows opening on the wrong monitor and notification
menus closing when their unread badge clears.
## Install or upgrade
Packages are available below for Fedora 44 and Arch Linux on 64-bit Intel and
AMD PCs. Other distributions can [build from source](https://github.com/ferese-wm/ferese/blob/v0.1.0/docs/installation.md).
If you're moving from a source installation to a package, follow the
[package installation guide](https://github.com/ferese-wm/ferese/blob/v0.1.0/docs/packaging.md#install-a-release-package)
first. Keep your personal configuration, then log out and back in after updating.
Found a problem? [Open an issue](https://github.com/ferese-wm/ferese/issues)
with what happened, how to reproduce it, and your Ferese version.