Skip to content
forked from qmk/qmk_firmware

QMK, forked for ZSA's Oryx Configurator (to safeguard stability)

License

GPL-2.0 and 2 other licenses found

Licenses found

GPL-2.0
LICENSE
GPL-2.0
license_GPLv2.md
GPL-3.0
license_GPLv3.md
Notifications You must be signed in to change notification settings

zsa/qmk_firmware

Folders and files

NameName
Last commit message
Last commit date

Latest commit

e777bc9 · Jul 23, 2024
Oct 2, 2023
Feb 5, 2024
Feb 5, 2024
Aug 23, 2023
Jul 11, 2024
Sep 5, 2023
Oct 2, 2023
Nov 15, 2023
Jun 26, 2024
Feb 5, 2024
Dec 21, 2023
Sep 5, 2023
Feb 12, 2022
May 14, 2023
Aug 13, 2019
Jan 5, 2022
Jun 13, 2024
Sep 30, 2023
Feb 21, 2022
Nov 14, 2017
Aug 27, 2023
Oct 7, 2021
Mar 28, 2017
Mar 28, 2017
Mar 28, 2017
Oct 1, 2019
Oct 20, 2022
Jul 23, 2024
Nov 22, 2021
Aug 21, 2022
Apr 13, 2022
Aug 23, 2022

Repository files navigation

ZSA's fork of QMK Firmware

Current Version Build firmware Unit Tests GitHub contributors GitHub forks

This purpose of this fork is maintain a clean repo that only contains the keyboard code that we need, and as little else as possible. This is to keep it lightweight, since we only need a couple of keyboards. This is the repo that the EZ Configurator will pull from.

Documentation

The docs are powered by Docsify and hosted on GitHub. They are also viewable offline; see Previewing the Documentation for more details.

You can request changes by making a fork and opening a pull request, or by clicking the "Edit this page" link at the bottom of any page.

Supported Keyboards

Building

To set up the local build enviroment to create the firmware image manually, head to the Newbs guide from QMK. And instead of using just qmk setup, you will want to run this instead:

qmk setup zsa/qmk_firmware -b firmware23

Maintainers

QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, Hasu. The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Update Process

  1. Check out branch from ZSA's master branch:

    1. git remote add zsa https://github.com/zsa/qmk_firmware.git
    2. git fetch --all
    3. git checkout -B branchname zsa/master
    4. git push -u zsa branchname
  2. Check for core changes:

  3. git merge (hash|tag)

    • git rm -rf docs users layouts .vscode to remove the docs and user code that we don't want.
    • To remove all of the keyboard exept the ones we want:
      find ./keyboards -mindepth 1 -maxdepth 1 -type d -not -name ergodox_ez -not -name planck -not -name moonlander -not -name pytest -exec git rm -rf '{}' \;
      find ./keyboards/planck -mindepth 1 -maxdepth 1 -type d -not -name ez -not -name base -not -name glow -not -name keymaps -exec git rm -rf '{}' \;
    • To remove all of the keymaps from folder that we don't want:
      find ./keyboards/ -mindepth 3 -maxdepth 3 -type d -not -name default -not -name oryx -not -name webusb -not -name glow -not -name reactive -not -name shine -not -name keymaps -not -name halfmoon -exec git rm -rf '{}' \;
    • Restore necessary files/folders:
      git checkout HEAD -- keyboards/handwired/pytest
      git checkout HEAD -- layouts
    • Resolve merge conflicts, and commit.
  4. Commit update

    • Include commit info in [changelog.md](changelog.md)
  5. Open Pull request, and include information about the commit

Strategy

To keep PRs small and easier to test, they should ideally be 1:1 with commits from QMK Firmware master. They should only group commits if/when it makes sense. Such as multiple commits for a specific feature (split RGB support, for instance)

About

QMK, forked for ZSA's Oryx Configurator (to safeguard stability)

Topics

Resources

License

GPL-2.0 and 2 other licenses found

Licenses found

GPL-2.0
LICENSE
GPL-2.0
license_GPLv2.md
GPL-3.0
license_GPLv3.md

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C 77.7%
  • C++ 15.6%
  • Python 4.1%
  • Makefile 2.2%
  • Shell 0.2%
  • Nix 0.1%
  • Other 0.1%