kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ZMK Firmware Fork to add Forgejo Workflow Support
2369 commits 18 branches 0 tags 93 MiB
C 96.3%
CMake 2.9%
Shell 0.5%
Python 0.3%
Find a file
Joel Spadin 14b06a36bf docs: Update settings_reset documentation 
Updated the section for troubleshooting split halves unable to pair now
that the settings_reset shield resets all settings and explicitly
disables CONFIG_ZMK_BLE:

- Added a note that all settings will be reset.
- Removed the section about immediately putting the halves into
  bootloader mode to prevent pairing, as this is not necessary anymore.
- Added a note that you will not be able to see or pair the Bluetooth
  keyboard until you have flashed regular firmware again.
- Added a sentence to clarify that you will need to re-pair the
  keyboard to all host devices.

Also added some text describing common scenarios where this procedure
might be needed.
2024-03-18 09:48:19 -07:00
.devcontainer chore(ci): Bump to 3.5 Docker images. 2024-02-09 14:32:46 -08:00
.github fix(build): Used a fixed temp dir for caching. 2024-02-14 14:08:22 -08:00
.vscode fix: Don't specify default C formatter 2023-05-14 11:54:34 -06:00
app feat(shields): Make settings_reset shield reset all settings 2024-03-18 09:48:19 -07:00
docs docs: Update settings_reset documentation 2024-03-18 09:48:19 -07:00
schema refactor: Add more checks to pre-commit 2023-04-24 16:07:04 -07:00
.clang-format feat(ci): Run clang-format to check files. 2020-09-14 00:08:13 -04:00
.gitattributes fix: check out Bash scripts with LF 2020-10-10 17:43:52 -05:00
.gitignore chore: Ignore python virtualenv files 2023-12-27 10:07:55 -08:00
.pre-commit-config.yaml chore: Update Prettier 2023-04-24 16:07:04 -07:00
AUTHORS Add KemoNine to authors per PeteJohnson 2020-12-07 07:07:45 -05:00
CODE_OF_CONDUCT.md refactor: Move to new zmk.dev domain name. 2021-06-10 09:27:57 -04:00
CODEOWNERS chore: Initial simple CODEOWNERS. 2021-01-13 20:59:11 -05:00
CONTRIBUTING.md feat(CONTRIBUTING.md): Add info regarding ESLint 2024-03-04 20:08:52 -08:00
LICENSE Updated copyright line. 2020-06-22 05:47:20 -04:00
README.md fix(docs): Fix README punctuation and add license link 2023-07-17 15:23:22 -07:00

README.md

Zephyr™ Mechanical Keyboard (ZMK) Firmware

Discord Build Contributor Covenant

ZMK Firmware is an open source (MIT) keyboard firmware built on the Zephyr™ Project Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues.

Check out the website to learn more: https://zmk.dev/.

You can also come join our ZMK Discord Server.

To review features, check out the feature overview. ZMK is under active development, and new features are listed with the enhancement label in GitHub. Please feel free to add 👍 to the issue description of any requests to upvote the feature.