Initial Ubuntu 24.04 Niri installer

README.md

@@ -0,0 +1,105 @@
+# Niri Beyond Glass
+
+面向 **Ubuntu 24.04 LTS** 的可移植 Niri 桌面配置。一条命令安装 Niri
+26.04、Xwayland 支持和一套克制的半透明桌面组件，同时保留原有 GNOME 与
+GDM，可在登录界面随时切换会话。
+
+## 效果与范围
+
+- Niri 滚动平铺、窗口圆角、阴影、流畅动画
+- 支持 Niri 26.04 的背景模糊、`xray` 和轻微噪点效果
+- Waybar 顶栏，时间位于最右侧区域，图标风格统一
+- Fuzzel 启动器、Mako 通知、Swaylock 锁屏和自动息屏
+- 中文快捷键说明
+- 浏览器、视频播放器、Steam 保持完全不透明
+- 自动备份已有配置，可卸载恢复
+
+本项目**不包含**动态壁纸、DMS、登录界面或 GRUB 主题，也不重新分发
+Wallpaper Engine 创意工坊图片。默认使用 Ubuntu 自带静态壁纸；安装时可指定
+自己的图片。
+
+## 一键安装
+
+```bash
+curl -fsSL https://git.k1412.top/wuyang/niri-beyond-glass/raw/branch/main/install.sh | bash
+```
+
+首次安装需要编译 Niri，耗时取决于 CPU 和网络。脚本会调用 `sudo` 安装依赖，
+但必须以普通用户运行。完成后注销，在 GDM 左下角的会话菜单选择 **Niri**。
+
+使用自己的静态壁纸：
+
+```bash
+curl -fsSL https://git.k1412.top/wuyang/niri-beyond-glass/raw/branch/main/install.sh \
+  -o /tmp/install-niri.sh
+bash /tmp/install-niri.sh --wallpaper "$HOME/Pictures/wallpaper.jpg"
+```
+
+只更新配置，不编译和安装软件：
+
+```bash
+bash /tmp/install-niri.sh --config-only
+```
+
+## 常用快捷键
+
+| 快捷键 | 功能 |
+|---|---|
+| `Super + Enter` | 终端 |
+| `Super + D` | 应用启动器 |
+| `Super + B` | 默认浏览器 |
+| `Super + E` | 文件管理器 |
+| `Super + O` | 总览 |
+| `Super + Q` | 关闭窗口 |
+| `Super + V` | 切换浮动 |
+| `Super + L` | 锁屏 |
+| `Super + Shift + /` | 中文快捷键总览 |
+| `Super + PageUp/PageDown` | 切换工作区 |
+| `Super + Shift + E` | 退出 Niri |
+
+`Super` 就是键盘上的 Windows 徽标键或 Mac 键盘上的 Command 键。
+
+## 安全设计
+
+- 仅支持 Ubuntu 24.04，检测到其他版本会停止
+- 不替换显示管理器，不修改 GDM，不移除 GNOME
+- 安装前备份 `niri`、`waybar`、`fuzzel`、`mako`、`swaylock`
+- Niri 和 Xwayland Satellite 固定到明确版本
+- Rust 工具链隔离在 `~/.local/share/niri-beyond-glass`
+- 配置安装后使用 `niri validate` 校验
+
+备份位于：
+
+```text
+~/.local/state/niri-beyond-glass/backups/
+```
+
+## 卸载
+
+```bash
+curl -fsSL https://git.k1412.top/wuyang/niri-beyond-glass/raw/branch/main/uninstall.sh | bash
+```
+
+卸载器恢复最近一次配置备份，并保留已安装的系统软件和 Niri 二进制，避免破坏
+其他会话。若要删除系统依赖，请按实际用途手动处理，不建议执行盲目的
+`apt autoremove`。
+
+## 已知限制
+
+- Niri 26.04 比 Ubuntu 24.04 更新，因此脚本采用源码编译，而不是跨版本安装
+  PPA 二进制包。
+- Ubuntu 24.04 自带的 `libdisplay-info` 版本不足时，脚本会在
+  `/usr/local` 编译安装 0.3.0。
+- 这是一套 Niri 配置，不复刻 DMS 的控制中心、登录页和动态壁纸。
+- NVIDIA 用户应先确保 Ubuntu 官方驱动在 GNOME Wayland 下工作正常。
+
+## 上游项目
+
+- [Niri](https://github.com/niri-wm/niri)
+- [Xwayland Satellite](https://github.com/Supreeeme/xwayland-satellite)
+- [Waybar](https://github.com/Alexays/Waybar)
+- [Fuzzel](https://codeberg.org/dnkl/fuzzel)
+
+## License
+
+[MIT](LICENSE)。Niri、Xwayland Satellite 及各依赖遵循其各自许可证。