Add dark website and documentation with GitHub Pages deployment

Include the updated desktop screenshot, active-monitor screenshot capture and editor locking, and Settings window drag areas.
This commit is contained in:
Samuel Onoja committed 2026-09-27 10:34:33 +01:00
1 parent e5e2b74a25
commit 0cd48bcc81
15 files changed
+1794 -12

No files matched your search

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.6 MiB

After

Width:  |  Height:  |  Size: 397 KiB

+17 -3
View File
@@ -2,14 +2,18 @@
## Build and install
On Fedora with SDDM, install a Rust toolchain (1.93 or newer), native build
On Fedora with SDDM, install a Rust toolchain (1.95 or newer), native build
dependencies, `desktop-file-utils`, D-Bus and `foot`. Wallpaper browsing also
needs `zenity`; locking needs swaylock or swaylock-effects.
Screenshots need `grim`, `slurp`, `satty`, and `wl-clipboard`.
Screenshots need `grim`, `slurp`, `satty`, `wl-clipboard`, and Python 3.
Print Screen captures the active monitor; Super+Shift+S selects an area.
Use `ferese-screenshot --all` to capture all monitors in one image.
From the checkout, run as your normal user:
Clone the repository, then run the installer as your normal user:
```sh
git clone https://github.com/borngraced/ferese.git
cd ferese
./scripts/install.sh
```
@@ -29,6 +33,16 @@ Use `--help` for all options. New configs can be copied from
## Preview and logs
To preview a source build before installing, run these commands from the checkout
inside an existing Wayland desktop:
```sh
cargo build --release --locked -p ferese -p ferese-shell -p ferese-settings -p feresectl
target/release/ferese --backend nested --grant-effects --grant-shell-control -- \
target/release/ferese-shell
```
Run `ferese-session --nested` inside an existing Wayland desktop. For a hardware
session, use the login screen or a spare TTY; never run Ferese as root or start
its DRM backend inside an active graphical session.
+8
View File
@@ -5,6 +5,8 @@ Cards appear beneath the bar on the focused output and follow the selected theme
Click the notification icon in the bar to open history, toggle Do Not Disturb, or
clear notifications. Escape or the close button closes the history panel.
## Send a notification
Notifications use the standard `org.freedesktop.Notifications` D-Bus interface.
Existing apps and `notify-send` work without Ferese-specific commands:
@@ -12,6 +14,8 @@ Existing apps and `notify-send` work without Ferese-specific commands:
notify-send --app-name=Ferese --icon=dialog-information "Hello" "Your desktop notification"
```
## Popups and history
Up to three popup cards are visible at once. History keeps the most recent 100
notifications in memory and clears when the shell exits. Hovering a popup pauses
its timer. Critical notifications bypass Do Not Disturb and do not expire unless
@@ -19,6 +23,8 @@ the sender supplies a timeout. App action buttons emit the standard action signa
a replacement updates the same notification ID. Transient messages are removed
from history when they close.
## Settings and Do Not Disturb
Settings → Notifications controls popup visibility, the initial Do Not Disturb
state, and the default timeout. The bar's Do Not Disturb toggle is temporary;
changing the Settings option saves the preference for future sessions. Apps can
@@ -35,6 +41,8 @@ notifications {
The timeout must be between 1000 and 30000 milliseconds. Hiding popups still
records notifications in history. Appearance follows the Ferese theme.
## Session integration
Only one notification server can own the D-Bus interface. The Ferese session
launcher stops the SwayNotificationCenter user service before starting its shell.
For a manually started shell, stop that service with `systemctl --user stop