Skip to content

Commit fdf78a8

Browse files
committed
chore: update README
1 parent c7300c7 commit fdf78a8

2 files changed

Lines changed: 32 additions & 26 deletions

File tree

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
English | [Nederlands](README.nl.md)
44

5-
CachyOS on the ASUS ROG Zephyrus G16 GA605WV (2024). My personal setup log documenting what worked, what didn't, and how I fixed it.
5+
CachyOS on the ASUS ROG Zephyrus G16 GA605WV (2024). My personal setup log: documenting what worked, what didn't, and how I fixed it.
66

77
**Browse the full documentation site: [zephyrus-linux.stensel.nl](https://zephyrus-linux.stensel.nl/)**
88

99

1010
## About this project
1111

12-
This is my personal setup log for running CachyOS on this laptop. I'm not a software engineer or developer just someone who switched to Linux and ran into a lot of things that didn't work out of the box. I figured I'd write it all down so others don't have to go through the same trial and error I did.
12+
This is my personal setup log for running CachyOS on this laptop. I'm not a software engineer or developer: just someone who switched to Linux and ran into a lot of things that didn't work out of the box. I figured I'd write it all down so others don't have to go through the same trial and error I did.
1313

14-
I'm still actively testing and experimenting things may change, break, or turn out to be wrong. Everything here is based on my own experience and should be taken as-is, at your own risk.
14+
I'm still actively testing and experimenting: things may change, break, or turn out to be wrong. Everything here is based on my own experience and should be taken as-is, at your own risk.
1515

1616
I am not affiliated with, endorsed by, or acting on behalf of ASUS, NVIDIA, Microsoft, CachyOS, or any other company or project mentioned here.
1717

@@ -36,7 +36,7 @@ I am not affiliated with, endorsed by, or acting on behalf of ASUS, NVIDIA, Micr
3636

3737
## Building the site locally
3838

39-
This documentation site is built with [Hugo](https://gohugo.io/) using the [Hextra](https://imfing.github.io/hextra/) theme. The theme is managed as a Hugo module (via Go modules no git submodules).
39+
This documentation site is built with [Hugo](https://gohugo.io/) using the [Hextra](https://imfing.github.io/hextra/) theme. The theme is managed as a Hugo module (via Go modules, no git submodules).
4040

4141
**Prerequisites:**
4242
- [Hugo extended](https://gohugo.io/installation/) v0.157.0 (built with this version)
@@ -73,7 +73,7 @@ The output is written to `./public/`. On push to `main`, GitHub Actions builds a
7373

7474
## Image assets
7575

76-
All images in this repository use the [AVIF](https://en.wikipedia.org/wiki/AVIF) format open, royalty-free, and more efficient than PNG or JPEG at equivalent quality. AVIF is the modern standard for web images.
76+
All images in this repository use the [AVIF](https://en.wikipedia.org/wiki/AVIF) format: open, royalty-free, and more efficient than PNG or JPEG at equivalent quality. AVIF is the modern standard for web images.
7777

7878
To convert PNG screenshots to AVIF, install `avifenc` from the `libavif` package:
7979

@@ -88,20 +88,23 @@ cd static/images
8888
for f in *.png; do avifenc -q 80 -s 6 "$f" "${f%.png}.avif" && rm "$f"; done
8989
```
9090

91-
- `-q 80` 80% quality (0–100 scale, 100 = lossless)
92-
- `-s 6` encoder speed (0 = best compression, 10 = fastest)
91+
- `-q 80`: 80% quality (0–100 scale, 100 = lossless)
92+
- `-s 6`: encoder speed (0 = best compression, 10 = fastest)
9393

9494

9595
## Credits & resources
9696

9797
This project wouldn't exist without the work of these people and communities:
9898

99-
- **[Luke Jones](https://asus-linux.org/)** — Creator of `asusctl`, `rog-control-center`, and the `asus-armoury` kernel driver. The ASUS Linux project is the reason modern ASUS laptops work well on Linux at all. His patches have been merged into CachyOS, making it the best supported distribution for ASUS ROG hardware.
100-
- **[CachyOS](https://cachyos.org/)** — The distribution powering this setup. CachyOS is an Arch-based distro with extensive hardware-specific optimizations: an improved scheduler (BORE/EEVDF), better power management, dynamic refresh rate support, and built-in drivers for both the AMD iGPU and NVIDIA dGPU — including integrated GPU switching. Of all the distributions I tested (including Fedora, which came close), CachyOS is by far the strongest on this device.
101-
- **[lz42/libinput-config](https://github.com/lz42/libinput-config)** — Third-party workaround for GNOME/Wayland's missing scroll speed setting.
102-
- **[Looking Glass](https://looking-glass.io/)** — Low-latency VM display project. Didn't work on this hardware, but the project and documentation are excellent.
103-
- **[Mastermindzh/tidal-hifi](https://github.com/Mastermindzh/tidal-hifi)** — Community Electron client for Tidal on Linux.
104-
- **[Hextra](https://imfing.github.io/hextra/)** — The Hugo theme powering the documentation site.
99+
- **[ASUS Linux community](https://asus-linux.org/)**: The project behind `asusctl` and `rog-control-center`. Luke Jones has been a major driving force, but numerous contributors have submitted kernel patches, many of which are now merged into mainline Linux, making modern ASUS ROG laptops genuinely usable on Linux.
100+
- **[CachyOS](https://cachyos.org/)**: The distribution powering this setup. CachyOS is an Arch-based distro with extensive hardware-specific optimizations: an improved scheduler (BORE/EEVDF), better power management, dynamic refresh rate support, and built-in drivers for both the AMD iGPU and NVIDIA dGPU, including integrated GPU switching. Of all the distributions I tested (including Fedora, which came close), CachyOS is by far the strongest on this device.
101+
- **[Foxboron/sbctl](https://github.com/Foxboron/sbctl)**: Secure Boot key management tool used to enroll custom keys and sign the kernel and EFI binaries. Essential for keeping Secure Boot enabled with a custom kernel.
102+
- **[sched-ext / scx_lavd](https://github.com/sched-ext/scx)**: The Linux scheduler extensibility framework powering the `scx_lavd` CPU scheduler. Excellent latency and responsiveness for desktop and gaming workloads.
103+
- **[lz42/libinput-config](https://github.com/lz42/libinput-config)**: Kernel-level workaround for GNOME/Wayland's missing scroll speed setting, intercepting libinput events before they reach the compositor.
104+
- **[Yubico/pam-u2f](https://github.com/Yubico/pam-u2f)**: PAM module enabling FIDO2/WebAuthn hardware token authentication for sudo and the lock screen. Used alongside `systemd-cryptenroll` for full-disk encryption unlock via YubiKey.
105+
- **[Looking Glass](https://looking-glass.io/)**: Low-latency GPU passthrough display project. Didn't work on this hardware, but the project and documentation are excellent.
106+
- **[Hugo](https://gohugo.io/)**: The static site generator used to build the documentation site.
107+
- **[Hextra](https://imfing.github.io/hextra/)**: The Hugo theme powering the documentation site.
105108

106109

107110
## License

README.nl.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
Nederlands | [English](README.md)
44

5-
CachyOS op de ASUS ROG Zephyrus G16 GA605WV (2024). Mijn persoonlijke setup-log wat werkte, wat niet, en hoe ik het heb opgelost.
5+
CachyOS op de ASUS ROG Zephyrus G16 GA605WV (2024). Mijn persoonlijke setup-log: wat werkte, wat niet, en hoe ik het heb opgelost.
66

77
**Bekijk de volledige documentatiesite: [zephyrus-linux.stensel.nl](https://zephyrus-linux.stensel.nl/nl/)**
88

99

1010
## Over dit project
1111

12-
Dit is mijn persoonlijke setup-log voor CachyOS op deze laptop. Ik ben geen software-engineer of developer gewoon iemand die naar Linux is overgestapt en daarna tegen van alles aanliep wat niet meteen werkte. Ik heb alles opgeschreven zodat anderen niet hetzelfde hoeven uitzoeken als ik.
12+
Dit is mijn persoonlijke setup-log voor CachyOS op deze laptop. Ik ben geen software-engineer of developer: gewoon iemand die naar Linux is overgestapt en daarna tegen van alles aanliep wat niet meteen werkte. Ik heb alles opgeschreven zodat anderen niet hetzelfde hoeven uitzoeken als ik.
1313

14-
Ik ben nog actief aan het testen en experimenteren dingen kunnen veranderen, kapot gaan of achteraf onjuist blijken. Alles wat hier staat is gebaseerd op mijn eigen ervaring en is op eigen risico.
14+
Ik ben nog actief aan het testen en experimenteren: dingen kunnen veranderen, kapot gaan of achteraf onjuist blijken. Alles wat hier staat is gebaseerd op mijn eigen ervaring en is op eigen risico.
1515

1616
Ik ben niet gelieerd aan, goedgekeurd door, of handelend namens ASUS, NVIDIA, Microsoft, CachyOS, of enig ander bedrijf of project dat hier wordt genoemd.
1717

@@ -36,7 +36,7 @@ Ik ben niet gelieerd aan, goedgekeurd door, of handelend namens ASUS, NVIDIA, Mi
3636

3737
## De site lokaal bouwen
3838

39-
Deze documentatiesite is gebouwd met [Hugo](https://gohugo.io/) en het [Hextra](https://imfing.github.io/hextra/)-thema. Het thema is opgenomen als Hugo module (via Go modules geen git submodules).
39+
Deze documentatiesite is gebouwd met [Hugo](https://gohugo.io/) en het [Hextra](https://imfing.github.io/hextra/)-thema. Het thema is opgenomen als Hugo module (via Go modules, geen git submodules).
4040

4141
**Vereisten:**
4242
- [Hugo extended](https://gohugo.io/installation/) v0.157.0 (gebouwd met deze versie)
@@ -73,7 +73,7 @@ De output wordt geschreven naar `./public/`. Bij een push naar `main` bouwt GitH
7373

7474
## Afbeeldingen
7575

76-
Alle afbeeldingen in deze repository gebruiken het [AVIF](https://nl.wikipedia.org/wiki/AVIF)-formaat open, royaltyvrij en efficiënter dan PNG of JPEG bij vergelijkbare kwaliteit. AVIF is de moderne standaard voor webafbeeldingen.
76+
Alle afbeeldingen in deze repository gebruiken het [AVIF](https://nl.wikipedia.org/wiki/AVIF)-formaat: open, royaltyvrij en efficiënter dan PNG of JPEG bij vergelijkbare kwaliteit. AVIF is de moderne standaard voor webafbeeldingen.
7777

7878
Installeer `avifenc` uit het `libavif`-pakket om PNG-screenshots om te zetten naar AVIF:
7979

@@ -88,20 +88,23 @@ cd static/images
8888
for f in *.png; do avifenc -q 80 -s 6 "$f" "${f%.png}.avif" && rm "$f"; done
8989
```
9090

91-
- `-q 80` 80% kwaliteit (schaal 0–100, 100 = verliesvrij)
92-
- `-s 6` encodersnelheid (0 = beste compressie, 10 = snelst)
91+
- `-q 80`: 80% kwaliteit (schaal 0–100, 100 = verliesvrij)
92+
- `-s 6`: encodersnelheid (0 = beste compressie, 10 = snelst)
9393

9494

9595
## Credits & bronnen
9696

9797
Dit project zou niet bestaan zonder het werk van deze mensen en communities:
9898

99-
- **[Luke Jones](https://asus-linux.org/)** — Maker van `asusctl`, `rog-control-center` en de `asus-armoury` kernel driver. Het ASUS Linux project is de reden dat moderne ASUS laptops goed werken op Linux. Zijn patches zijn gemerged in CachyOS, waardoor dit de best ondersteunde distributie is voor ASUS ROG hardware.
100-
- **[CachyOS](https://cachyos.org/)** — De distributie die deze setup aandrijft. CachyOS is een op Arch gebaseerde distro met uitgebreide hardware-specifieke optimalisaties: een verbeterde scheduler (BORE/EEVDF), beter energiebeheer, ondersteuning voor dynamische verversingsfrequentie, en ingebouwde drivers voor zowel de AMD iGPU als de NVIDIA dGPU — inclusief geïntegreerde GPU-switching. Van alle distributies die ik getest heb (waaronder Fedora, dat dicht in de buurt kwam), is CachyOS veruit de sterkste op dit apparaat.
101-
- **[lz42/libinput-config](https://github.com/lz42/libinput-config)** — Third-party workaround voor de ontbrekende scroll speed-instelling in GNOME/Wayland.
102-
- **[Looking Glass](https://looking-glass.io/)** — Low-latency VM display project. Werkt niet op deze hardware, maar het project en de documentatie zijn uitstekend.
103-
- **[Mastermindzh/tidal-hifi](https://github.com/Mastermindzh/tidal-hifi)** — Community Electron-client voor Tidal op Linux.
104-
- **[Hextra](https://imfing.github.io/hextra/)** — Het Hugo-thema waarop de documentatiesite is gebouwd.
99+
- **[ASUS Linux community](https://asus-linux.org/)**: Het project achter `asusctl` en `rog-control-center`. Luke Jones heeft hier een grote drijvende kracht achter geweest, maar ook andere bijdragers hebben kernel patches ingediend, waarvan velen inmiddels in mainline Linux zijn gemerged, waardoor moderne ASUS ROG laptops echt bruikbaar zijn op Linux.
100+
- **[CachyOS](https://cachyos.org/)**: De distributie die deze setup aandrijft. CachyOS is een op Arch gebaseerde distro met uitgebreide hardware-specifieke optimalisaties: een verbeterde scheduler (BORE/EEVDF), beter energiebeheer, ondersteuning voor dynamische verversingsfrequentie, en ingebouwde drivers voor zowel de AMD iGPU als de NVIDIA dGPU, inclusief geïntegreerde GPU-switching. Van alle distributies die ik getest heb (waaronder Fedora, dat dicht in de buurt kwam), is CachyOS veruit de sterkste op dit apparaat.
101+
- **[Foxboron/sbctl](https://github.com/Foxboron/sbctl)**: Beheertool voor Secure Boot-sleutels, gebruikt voor het inschrijven van eigen sleutels en het ondertekenen van de kernel en EFI-binaries. Onmisbaar voor het actief houden van Secure Boot met een aangepaste kernel.
102+
- **[sched-ext / scx_lavd](https://github.com/sched-ext/scx)**: Het Linux scheduler-extensibiliteitsframework achter de `scx_lavd` CPU-scheduler. Uitstekende latentie en responsiviteit voor desktop- en gamingworkloads.
103+
- **[lz42/libinput-config](https://github.com/lz42/libinput-config)**: Kernel-niveau workaround voor de ontbrekende scroll speed-instelling in GNOME/Wayland, door libinput-events te onderscheppen vóór de compositor ze verwerkt.
104+
- **[Yubico/pam-u2f](https://github.com/Yubico/pam-u2f)**: PAM-module voor FIDO2/WebAuthn hardware token-authenticatie bij sudo en het vergrendelscherm. Gebruikt samen met `systemd-cryptenroll` voor schijfversleuteling via YubiKey.
105+
- **[Looking Glass](https://looking-glass.io/)**: Low-latency GPU passthrough display project. Werkt niet op deze hardware, maar het project en de documentatie zijn uitstekend.
106+
- **[Hugo](https://gohugo.io/)**: De statische sitegenerator waarmee de documentatiesite is gebouwd.
107+
- **[Hextra](https://imfing.github.io/hextra/)**: Het Hugo-thema waarop de documentatiesite is gebouwd.
105108

106109

107110
## Licentie

0 commit comments

Comments
 (0)