Skip to content

Commit 08dc2a2

Browse files
committed
update doc
1 parent 9517e51 commit 08dc2a2

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

data/doc/0.description.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# 🤷 What is this
22

3-
Way-Edges is an application written in Rust for Wayland users, widgets can seamlessly hide along your screen's borders, Enhance your workspace with clean, efficient edge triggers. Built with [gtk4-layer-shell](https://github.com/pentamassiv/gtk4-layer-shell-gir), all widgets are designed personally and draw with [Cairo](https://github.com/gtk-rs/gtk-rs-core).
3+
Way-Edges is a lightweight application written in Rust for Wayland users, providing off-screen widgets hidden along the edges of the screen.
44

55
## ✨ Features
66

77
- 💻 Do not take up any screen space, better for small screens
8-
- ⚙️ Provide presets for audio, screen brightness, system information...
9-
- 🦅 Relative size, edge, anchor, margin customization, arrange your widgets.
8+
- ⚙️ Provide modules for audio, brightness, system information...
109
- 📦 Grouping widgets
10+
- 🌱 Better performance and less resource usage, we are not using any GUI framework here
1111
- ⚡ Written in Rust (?)
1212

1313
## 🥢 Requirements
1414

15-
- Wayland
16-
- [GTK4](https://docs.gtk.org/gtk4/) && [GTK4-layer-shell](https://github.com/wmww/gtk4-layer-shell)
17-
- [PulseAudio](https://wiki.archlinux.org/title/PulseAudio) ([pipewire-pulse](https://archlinux.org/packages/extra/x86_64/pipewire-pulse/) recommended)
18-
- A Window Manager supports well of wayland layer shell
15+
- wayland
16+
- xkbcommon
17+
- cairo (about to be replaced)
18+
- libpulse ([pipewire-pulse](https://archlinux.org/packages/extra/x86_64/pipewire-pulse/) recommended)
19+
- A compositor supports well of layer shell

src/app/layout.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export const metadata: Metadata = {
1212
applicationName: 'Way-Edges',
1313
authors: { url: 'https://github.com/ogios', name: 'OGIOS' },
1414
generator: 'Next.js',
15-
keywords: ['wayland', 'unix', 'gtk', 'way-edges', 'custom widgets', 'doc'],
15+
keywords: ['wayland', 'unix', 'smithay', 'way-edges', 'custom widgets', 'doc'],
1616
creator: 'OGIOS',
1717
category: 'Wayland Client',
1818
}

0 commit comments

Comments
 (0)