docs: rewrite README for personal fork #34

2026-09-23T22:10:16Z

rootiest commented

2026-09-23 22:10:16 +00:00

Old README was upstream QMK boilerplate — badges, generic feature list, QMK maintainer credits — that didn't match what this repo actually is.

Replaces it with:

Overview of this fork's actual keymaps (Keychron Q5 Max, K17 Max)
Build/flash quickstart with the local qmk CLI
A note that git.rootiest.dev (Gitea) is the primary repo, github.com is a one-way mirror (direct pushes there get overwritten), and GitHub hosts the prebuilt firmware releases
Link out to docs.qmk.fm instead of duplicating upstream docs

Old README was upstream QMK boilerplate — badges, generic feature list, QMK maintainer credits — that didn't match what this repo actually is. Replaces it with: - Overview of this fork's actual keymaps (Keychron Q5 Max, K17 Max) - Build/flash quickstart with the local `qmk` CLI - A note that git.rootiest.dev (Gitea) is the primary repo, github.com is a one-way mirror (direct pushes there get overwritten), and GitHub hosts the prebuilt firmware releases - Link out to docs.qmk.fm instead of duplicating upstream docs

rootiest added 1 commit 2026-09-23 22:10:18 +00:00

docs: rewrite README for personal fork, add Gitea/GitHub mirror note 82b0949a23

Old README was upstream QMK boilerplate (badges, generic feature list,
QMK maintainer credits) that no longer matched this repo's purpose.
Replaced with an overview of this fork's actual keymaps (Keychron Q5
Max, K17 Max) plus a note that git.rootiest.dev is the primary repo
and github.com is a one-way mirror (direct GitHub pushes get
overwritten) that also hosts the prebuilt firmware releases.

rootiest merged commit cb4d318bbe into main

2026-09-23 22:11:02 +00:00

rootiest deleted branch docs/readme-fork-overview

2026-09-23 22:11:03 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: rootiest/qmk_firmware#34