Simplify documentation and website; expand shortcut guides
This commit is contained in:
Samuel Onoja committed
1 parent
46509f880a
commit
4d60c296a7
26 files changed
+1060
-1032
No files matched your search
@@ -2,60 +2,35 @@
|
||||
<img src="docs/images/ferese-lockup.svg" width="300" alt="Ferese">
|
||||
</p>
|
||||
|
||||
<p align="center"><strong>A beautiful, fluid Wayland desktop made to feel like yours.</strong></p>
|
||||
<p align="center"><strong>A Wayland desktop with scrolling layouts and a shared theme.</strong></p>
|
||||
|
||||
<p align="center">
|
||||
<a href="docs/installation.md">Install</a> ·
|
||||
<a href="docs/configuration.md">Configure</a> ·
|
||||
<a href="docs/desktop-widgets.md">Widgets</a> ·
|
||||
<a href="docs/notifications.md">Notifications</a>
|
||||
<a href="docs/README.md">Documentation</a>
|
||||
</p>
|
||||
|
||||
Ferese is a complete Wayland desktop built around personalization. Its custom
|
||||
shell, native settings, live-reloading themes and wallpapers, desktop widgets,
|
||||
fluid animations, and scrolling and tiling layouts work together as one
|
||||
cohesive experience—beautiful by default and unmistakably yours.
|
||||
Ferese is a Linux desktop with scrolling columns, tree tiling, and floating
|
||||
windows. It includes a top bar, Settings, notifications, desktop widgets, a
|
||||
lock screen, and screen sharing. Change themes and settings without restarting.
|
||||
|
||||
|
||||
|
||||
## Why Ferese
|
||||
## Features
|
||||
|
||||
- **Flexible layouts:** scrolling columns, tree tiling, floating windows and a
|
||||
workspace overview.
|
||||
- **A native shell:** menu bar, control center, settings, notifications and
|
||||
desktop widgets designed to belong together, including themed authentication prompts.
|
||||
Native apps share the [Ferese theme components](crates/ferese-theme/README.md).
|
||||
- **Personal by design:** themes, wallpapers, accent colors, blur, borders and
|
||||
motion that update without restarting your session.
|
||||
- **Ready for real setups:** gestures, multi-monitor support, fractional
|
||||
scaling, screenshots, background services and session locking.
|
||||
- **Screen sharing:** a native display picker and PipeWire video streams for
|
||||
portal-compatible recording and conferencing apps.
|
||||
- Scrolling and tree layouts, floating windows, and a workspace overview.
|
||||
- Configurable keyboard shortcuts and touchpad gestures.
|
||||
- Multiple monitors with fractional scaling.
|
||||
- Six theme presets, wallpapers, blur, and adjustable corners.
|
||||
- Clock and sticky-note widgets.
|
||||
- Screenshots with Satty editing, screen sharing, and top-bar recording.
|
||||
|
||||
|
||||
|
||||
The overview brings windows and workspaces into one view. Read more about
|
||||
[why Ferese builds the compositor and shell together](docs/why-ferese.md).
|
||||
|
||||
## Make it yours
|
||||
|
||||
Use the native Settings app for everyday customization, or edit
|
||||
`~/.config/ferese/config.kdl` when you want complete control. Ferese reloads
|
||||
changes as you make them and keeps the last working configuration if an edit is
|
||||
invalid.
|
||||
|
||||
|
||||
|
||||
Choose a preset or build your own look. Window behavior, gestures, shortcuts,
|
||||
rules, displays, widgets and login items are configurable too. Start with the
|
||||
[configuration guide](docs/configuration.md) or the
|
||||
[example config](packaging/config.kdl).
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
Install Ferese on Linux with any Wayland-capable login manager, a command-based
|
||||
greeter, or a local TTY. Start with the [installation guide](docs/installation.md)
|
||||
for system dependencies and Rust 1.95 or newer, then build as your normal user:
|
||||
Install the [dependencies](docs/installation.md#requirements), then build as your
|
||||
normal user:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/ferese-wm/ferese.git
|
||||
@@ -63,59 +38,48 @@ cd ferese
|
||||
./scripts/install.sh
|
||||
```
|
||||
|
||||
Log out and select **Ferese** at your login screen. For greeters that take a
|
||||
session command, use `/usr/local/bin/ferese-session`. The installer preserves
|
||||
your configuration and other sessions, and retains the previous release for
|
||||
rollback. The guide covers [all startup methods](docs/installation.md#start-a-session),
|
||||
optional tools, updates, and recovery.
|
||||
Log out, select **Ferese** at your login screen, and sign in. For a TTY or a
|
||||
greeter that accepts a command, run `ferese-session`.
|
||||
See [Installation](docs/installation.md) for previews, updates, and recovery.
|
||||
|
||||
To preview Ferese inside your current Wayland desktop instead:
|
||||
## Configure
|
||||
|
||||
```sh
|
||||
cargo build --release --locked -p ferese -p ferese-shell -p ferese-settings -p feresectl -p ferese-lock
|
||||
target/release/ferese --backend nested --grant-effects --grant-shell-control -- \
|
||||
target/release/ferese-shell
|
||||
```
|
||||
Open **Control Center → Settings**, or edit `~/.config/ferese/config.kdl`.
|
||||
Changes reload automatically; invalid edits keep the last working configuration.
|
||||
|
||||
## Get around
|
||||
|
||||
|
||||
These are the built-in defaults; every shortcut and gesture can be changed.
|
||||
The login guide shows your active shortcuts. Disable it in **Settings → Shortcuts**
|
||||
when you no longer need it.
|
||||
See the [configuration reference](docs/configuration.md) and
|
||||
[example config](packaging/config.kdl).
|
||||
|
||||
## Default shortcuts
|
||||
|
||||
`Super` is usually the Windows key. Change shortcuts and gestures in
|
||||
**Settings → Shortcuts**.
|
||||
|
||||
| Shortcut | Action |
|
||||
| --- | --- |
|
||||
| Super + Enter | Open a terminal |
|
||||
| Super + H / J / K / L | Focus a window |
|
||||
| Super + H / J / K / L | Focus left / down / up / right |
|
||||
| Super + F | Maximize the window |
|
||||
| Super + Shift + F | Toggle fullscreen |
|
||||
| Super + R | Cycle column width |
|
||||
| Super + Tab | Open workspace and window overview |
|
||||
| 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 |
|
||||
|
||||
Click the bar date for a calendar. Click the battery for power modes and
|
||||
confirmed Restart, Power off and Suspend actions.
|
||||
See [all shortcuts and mouse actions](docs/shortcuts.md), including Super-drag
|
||||
to move and Super-right-drag to resize floating windows.
|
||||
|
||||
Three-finger swipes move between workspaces and windows. Open **Control Center →
|
||||
Settings → Shortcuts** to change them or assign gestures to other actions.
|
||||
Three-finger swipes up/down switch workspaces; left/right focus windows.
|
||||
The shortcut guide appears at login until disabled in Settings.
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Why Ferese](docs/why-ferese.md)
|
||||
- [Installation and recovery](docs/installation.md)
|
||||
- [Configuration reference](docs/configuration.md)
|
||||
- [Desktop widgets](docs/desktop-widgets.md)
|
||||
- [Notifications](docs/notifications.md)
|
||||
- [Native locker](docs/locking.md)
|
||||
- [Desktop portals and compatibility](docs/portals.md)
|
||||
- [Screen sharing and recording](docs/screen-sharing.md)
|
||||
Start with the [documentation index](docs/README.md) for user guides and
|
||||
[development instructions](docs/development.md) for builds and testing.
|
||||
|
||||
## Development
|
||||
|
||||
```sh
|
||||
cargo test --workspace --locked
|
||||
cargo fmt --all --check
|
||||
```
|
||||
|
||||
Ferese is built in Rust on Smithay. Use release builds when evaluating motion
|
||||
and startup performance, and keep another desktop session available while
|
||||
testing hardware behavior.
|
||||
Ferese is written in Rust using Smithay. Report bugs on
|
||||
[GitHub](https://github.com/ferese-wm/ferese/issues) with reproduction steps and logs.
|
||||
Reference in new issue
Block a user