kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ZMK Firmware Fork to add Forgejo Workflow Support
1876 commits 18 branches 0 tags 93 MiB
C 96.3%
CMake 2.9%
Shell 0.5%
Python 0.3%
Find a file
Joel Spadin 76c437647e Improve user setup process 
Changed the user setup documentation to use a new setup process where
users create the repo from the template repo, then run one of two new
tools to add a keyboard to it:

- In a web browser, using github.dev and the ZMK Tools extension.
- Locally, using a new Python setup script.

Also made various other improvements to the setup documentation, such
as including instructions for flashing keyboards that use DFU instead of
UF2.
2022-08-28 12:21:43 -05:00
.devcontainer refactor: Move to Zephyr v3.0.0 + ZMK fixes. 2022-04-03 00:10:29 -04:00
.github Set verbose output, simplify grep command, keep if statement consistent 2022-05-18 01:24:28 -04:00
.vscode chore: make west scripts more pythonic and apply Black 2022-01-04 23:59:25 -05:00
app feat(hid): Add C_AC_DESKTOP_SHOW_ALL_APPLICATIONS 2022-08-22 00:27:47 -04:00
docs Improve user setup process 2022-08-28 12:21:43 -05:00
schema feat(docs): add backlight to power profiler 2022-02-05 23:40:18 -05: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 add __pycache__ to gitignore now zmk contains python files 2020-11-21 14:47:01 -05:00
.pre-commit-config.yaml fix(pre-commit): use prettier mirror and pin version 2021-02-15 07:43:43 -05: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 fix: basic setup link 2021-08-12 19:12:30 -05:00
LICENSE Updated copyright line. 2020-06-22 05:47:20 -04:00
README.md refactor: Move to new zmk.dev domain name. 2021-06-10 09:27:57 -04: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.