Skip to content

Open-source keyboard firmware for Atmel AVR and Arm USB families

License

Notifications You must be signed in to change notification settings

LilleAila/qmk_firmware

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Quantum Mechanical Keyboard Firmware

QMK fork with my personal keymaps

My keyboard: keyboards/beekeeb/piantor_pro Compile firmware:

qmk compile -kb beekeeb/piantor_pro -km default
# Or to automatically flash:
qmk flash -kb beekeeb/piantor_pro -km default

Keeping a fork updated

Initializing the fork

# Make a fork on github.com
git clone https://github.com/your-username/qmk_firmware.git
cd qmk_firmware
git remote add upstream https://github.com/qmk/qmk_firmware.git

Make changes and commit

git add *
git commit -am "commit message"
git push origin master

Merge updates from qmk/qmk_firmware

git fetch upstream
git checkout master
git merge upstream/master
git push origin master

When cloning the repo

git clone [email protected]:LilleAila/qmk_firmware ~/qmk_firmware
cd ~/qmk_firmware
git submodule init
# Remember to enable `hardware.keyboard.qmk.enable` in NixOS!!
nix-shell
qmk setup

Original readme

Current Version Discord Docs Status GitHub contributors GitHub forks

This is a keyboard firmware based on the tmk_keyboard firmware with some useful features for Atmel AVR and ARM controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line.

Documentation

The docs are powered by VitePress. 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.

Supported Keyboards

The project also includes community support for lots of other keyboards.

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.

Official Website

qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.

About

Open-source keyboard firmware for Atmel AVR and Arm USB families

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C 93.5%
  • C++ 4.1%
  • Python 1.2%
  • Makefile 1.1%
  • Shell 0.1%
  • Nix 0.0%