Merge GitHub README edit into main
1 file · +3 -5
M README.md +3 -5
| @@ -10,7 +10,7 @@ | |||
| 10 | 10 | <p align="center">A Wayland compositor that spends its frames on your apps, not on itself.</p> | |
| 11 | 11 | ||
| 12 | 12 | > [!WARNING] | |
| 13 | - | > **Early alpha, but I use it every day.** Developed and tested mostly on AMD CPUs and GPUs. NVIDIA support is incomplete and untested. Expect bugs and breaking config changes. | |
| 13 | + | > **Early alpha, but stable enough for daily use.** Developed and tested mostly on AMD CPUs and GPUs. NVIDIA support is incomplete and untested (contribs welcome). Expect bugs and breaking config changes. | |
| 14 | 14 | ||
| 15 | 15 | ## Why NeferWL | |
| 16 | 16 | ||
| @@ -48,9 +48,7 @@ About 35 channels connect them, all created in one place, so the full data flow | |||
| 48 | 48 | - **Work only when something changes.** Damage tracking redraws only what changed, surfaces hidden behind opaque ones are skipped, and an idle output does nothing. | |
| 49 | 49 | - **Tuned on real hardware.** Under VRR, cursor moves ride on the game's next frame instead of forcing their own refresh, and game frames keep a short gap after each flip so the panel does not fall back to its slowest rate. | |
| 50 | 50 | ||
| 51 | - | ### A pleasure to work on | |
| 52 | - | ||
| 53 | - | A full build takes seconds, and tests, race detection, profiling and formatting come with the language. I also like bringing more tools to the Go ecosystem. NeferWL grew its own libraries along the way, and other Go projects can use them: | |
| 51 | + | I also like bringing more tools to the Go ecosystem. NeferWL grew its own libraries along the way, and other Go projects can use them: | |
| 54 | 52 | ||
| 55 | 53 | - [purego-libwayland](https://github.com/bnema/purego-libwayland): libwayland-server without cgo. | |
| 56 | 54 | - [purego-vulkan](https://github.com/bnema/purego-vulkan): Vulkan without cgo, generated from `vk.xml`. | |
| @@ -80,7 +78,7 @@ A full build takes seconds, and tests, race detection, profiling and formatting | |||
| 80 | 78 | ||
| 81 | 79 | ### Desktop integration | |
| 82 | 80 | ||
| 83 | - | Bring your own desktop UI: any layer-shell client, such as Noctalia or Waybar, works. No built-in bar, launcher or notifications; input methods like fcitx5 work through their standard protocols. For capture and idle management, see [nefercap](https://github.com/bnema/nefercap) and [neferafk](https://github.com/bnema/neferafk). | |
| 81 | + | Bring your own desktop UI: any layer-shell client, such as Noctalia or Waybar, works. For capture and idle management, see [nefercap](https://github.com/bnema/nefercap) and [neferafk](https://github.com/bnema/neferafk). | |
| 84 | 82 | ||
| 85 | 83 | Configuration is a flat `key = value` file that reloads on save. A JSON state file exposes outputs, workspaces and windows to scripts. See [Desktop integration](docs/desktop.md). | |
| 86 | 84 | ||
| @@ -10,7 +10,7 @@ | |||||
| 10 | <p align="center">A Wayland compositor that spends its frames on your apps, not on itself.</p> | 10 | <p align="center">A Wayland compositor that spends its frames on your apps, not on itself.</p> | ||
| 11 | 11 | ||||
| 12 | > [!WARNING] | 12 | > [!WARNING] | ||
| 13 | - | > **Early alpha, but I use it every day.** Developed and tested mostly on AMD CPUs and GPUs. NVIDIA support is incomplete and untested. Expect bugs and breaking config changes. | 13 | + | > **Early alpha, but stable enough for daily use.** Developed and tested mostly on AMD CPUs and GPUs. NVIDIA support is incomplete and untested (contribs welcome). Expect bugs and breaking config changes. |
| 14 | 14 | ||||
| 15 | ## Why NeferWL | 15 | ## Why NeferWL | ||
| 16 | 16 | ||||
| @@ -48,9 +48,7 @@ About 35 channels connect them, all created in one place, so the full data flow | |||||
| 48 | - **Work only when something changes.** Damage tracking redraws only what changed, surfaces hidden behind opaque ones are skipped, and an idle output does nothing. | 48 | - **Work only when something changes.** Damage tracking redraws only what changed, surfaces hidden behind opaque ones are skipped, and an idle output does nothing. | ||
| 49 | - **Tuned on real hardware.** Under VRR, cursor moves ride on the game's next frame instead of forcing their own refresh, and game frames keep a short gap after each flip so the panel does not fall back to its slowest rate. | 49 | - **Tuned on real hardware.** Under VRR, cursor moves ride on the game's next frame instead of forcing their own refresh, and game frames keep a short gap after each flip so the panel does not fall back to its slowest rate. | ||
| 50 | 50 | ||||
| 51 | - | ### A pleasure to work on | 51 | + | I also like bringing more tools to the Go ecosystem. NeferWL grew its own libraries along the way, and other Go projects can use them: |
| 52 | - | ||||
| 53 | - | A full build takes seconds, and tests, race detection, profiling and formatting come with the language. I also like bringing more tools to the Go ecosystem. NeferWL grew its own libraries along the way, and other Go projects can use them: | |||
| 54 | 52 | ||||
| 55 | - [purego-libwayland](https://github.com/bnema/purego-libwayland): libwayland-server without cgo. | 53 | - [purego-libwayland](https://github.com/bnema/purego-libwayland): libwayland-server without cgo. | ||
| 56 | - [purego-vulkan](https://github.com/bnema/purego-vulkan): Vulkan without cgo, generated from `vk.xml`. | 54 | - [purego-vulkan](https://github.com/bnema/purego-vulkan): Vulkan without cgo, generated from `vk.xml`. | ||
| @@ -80,7 +78,7 @@ A full build takes seconds, and tests, race detection, profiling and formatting | |||||
| 80 | 78 | ||||
| 81 | ### Desktop integration | 79 | ### Desktop integration | ||
| 82 | 80 | ||||
| 83 | - | Bring your own desktop UI: any layer-shell client, such as Noctalia or Waybar, works. No built-in bar, launcher or notifications; input methods like fcitx5 work through their standard protocols. For capture and idle management, see [nefercap](https://github.com/bnema/nefercap) and [neferafk](https://github.com/bnema/neferafk). | 81 | + | Bring your own desktop UI: any layer-shell client, such as Noctalia or Waybar, works. For capture and idle management, see [nefercap](https://github.com/bnema/nefercap) and [neferafk](https://github.com/bnema/neferafk). |
| 84 | 82 | ||||
| 85 | Configuration is a flat `key = value` file that reloads on save. A JSON state file exposes outputs, workspaces and windows to scripts. See [Desktop integration](docs/desktop.md). | 83 | Configuration is a flat `key = value` file that reloads on save. A JSON state file exposes outputs, workspaces and windows to scripts. See [Desktop integration](docs/desktop.md). | ||
| 86 | 84 | ||||