Go to file
Tony Grosinger 8d870812a3 Add instructions for building locally 2024-06-05 20:18:20 -07:00
.devcontainer chore(ci): Bump to 3.5 Docker images. 2024-02-09 14:32:46 -08:00
.vscode fix: Don't specify default C formatter 2023-05-14 11:54:34 -06:00
app Initial configuration for the Pseudacris board 2024-06-05 08:02:48 -07:00
docs feat(docs): Improve the toolchain setup page (#2272) 2024-06-01 21:51:08 -07:00
schema feat(boards): Support board revisions in setup scripts. 2024-03-30 19:12:37 -04: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 feat(gitignore): add clangd cache folder 2024-03-27 14:41:26 -07: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
CODEOWNERS chore: Initial simple CODEOWNERS. 2021-01-13 20:59:11 -05:00
CODE_OF_CONDUCT.md refactor: Move to new zmk.dev domain name. 2021-06-10 09:27:57 -04: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 Add instructions for building locally 2024-06-05 20:18:20 -07:00

README.md

ZMK

NOTE: Try to keep the repo up to date as much as possible. Pull from the upstream master and then rebase my branch on top of it.

Instructions for building

  1. Install devcontainer cli

    brew install devcontainer
    
  2. Setup the devcontainer

    devcontainer up --workspace-path . --docker-path $(which podman)
    
  3. Initialize west (this takes a while)

    devcontainer exec --workspace-path . --docker-path $(which podman)
    west init -l app/
    west update
    
  4. Build the firmware

    cd app
    west build --pristine -b nice_nano_v2 -- -DSHIELD=chrysemys
    
  5. Copy the uf2 file onto the root of the USB mass storage for the keyboard. The uf2 file can be found at app/build/zephyr/zmk.uf2.

Documentation