kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ZMK Firmware Fork to add Forgejo Workflow Support
2359 commits 18 branches 0 tags 93 MiB
C 96.3%
CMake 2.9%
Shell 0.5%
Python 0.3%
Find a file
adisbladis 2857e2495b Add Nix flake 
This is another take on #1026 that aims to minimally implement a Nix development environment.

Notable differences are:

- Uses `pyproject.nix` for auto-packaging of the environment
  - Mach-nix is unmaintained
    Not only is it unmaintained but extremely heavy weight.

  - Uses nixpkgs Python packages
    Which means better binary cache performance than mach-nix offers.

- No direnv additions
I use direnv myself but expect users to be able to `echo 'use flake' > .envrc` if they want to use direnv.

- Uses zephyr sources from a flake input
This should make maintenance simpler as there is no manual updating required.
2024-02-20 20:43:41 +13: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(boards): add encoder support to planck 2024-02-19 17:01:10 -08:00
docs feat(docs): Add pointers for peripheral battery monitoring (#2177) 2024-02-17 21:51:09 -08: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 fix: basic setup link 2021-08-12 19:12:30 -05:00
flake.lock Add Nix flake 2024-02-20 20:43:41 +13:00
flake.nix Add Nix flake 2024-02-20 20:43:41 +13: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.