Compare commits

..

2 Commits

Author SHA1 Message Date
70a03fa30f Remove github actions workflows
These don't seem to work when running on Gitea, so let's just prevent
them from running.
2024-06-05 20:13:01 -07:00
5ec0b5e18a Add instructions for building locally 2024-06-05 20:12:10 -07:00
2 changed files with 44 additions and 33 deletions

View File

@ -1,38 +1,13 @@
# ZMK
# Zephyr™ Mechanical Keyboard (ZMK) Firmware
## Instructions for building
[![Discord](https://img.shields.io/discord/719497620560543766)](https://zmk.dev/community/discord/invite)
[![Build](https://github.com/zmkfirmware/zmk/workflows/Build/badge.svg)](https://github.com/zmkfirmware/zmk/actions)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
1. Install devcontainer cli
[ZMK Firmware](https://zmk.dev/) is an open source ([MIT](LICENSE)) keyboard firmware built on the [Zephyr™ Project](https://www.zephyrproject.org/) Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues.
```sh
brew install devcontainer
```
Check out the website to learn more: https://zmk.dev/.
2. Setup the devcontainer
```sh
devcontainer up --workspace-path . --docker-path $(which podman)
```
3. Initialize west (this takes a while)
```sh
devcontainer exec --workspace-path . --docker-path $(which podman)
west init -l app/
west update
```
4. Build the firmware
```sh
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
- [Docker setup](https://zmk.dev/docs/development/setup/docker)
- [Building](https://zmk.dev/docs/development/build-flash)
You can also come join our [ZMK Discord Server](https://zmk.dev/community/discord/invite).
To review features, check out the [feature overview](https://zmk.dev/docs/). ZMK is under active development, and new features are listed with the [enhancement label](https://github.com/zmkfirmware/zmk/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) in GitHub. Please feel free to add 👍 to the issue description of any requests to upvote the feature.

36
tgrosinger-readme.md Normal file
View File

@ -0,0 +1,36 @@
# Instructions for building
1. Install devcontainer cli
```sh
brew install devcontainer
```
2. Setup the devcontainer
```sh
devcontainer up --workspace-path . --docker-path $(which podman)
```
3. Initialize west (this takes a while)
```sh
devcontainer exec --workspace-path . --docker-path $(which podman)
west init -l app/
west update
```
4. Build the firmware
```sh
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
- [Docker setup](https://zmk.dev/docs/development/setup/docker)
- [Building](https://zmk.dev/docs/development/build-flash)