diff --git a/README.md b/README.md index a3784efe8fa..8eccc3f7ec5 100644 --- a/README.md +++ b/README.md @@ -12,26 +12,31 @@ You can also come join our [ZMK Discord Server](https://zmk.dev/community/discor 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. -[Keychron](https://keychron.com/) use zmk source code for Bpro series keyboards ,have made big changes fro Bpro, also add proprietary 2.4g communication. +[Keychron](https://keychron.com/) uses ZMK source code for B Pro series keyboards and have made big changes for B Pro. Keychron also added proprietary 2.4 GHz communication. -To build the firmware ,for example: keychorn b1 pro +To build the firmware, for example, Keychron B1 Pro: -prepare: -``` +Prepare: + +``` mkdir keychron cd keychron - git clone -b keychron_bpro https://github.com/keychron/zmk.git + git clone -b keychron_bpro https://github.com/keychron/zmk.git cd zmk west init -l app/ west update ``` -patch zephyr: + +Patch Zephyr: + ``` cd zephyr - git am ../001-esb-nrf-fix.patch + git am ../0001-esb-nrf-fix.patch ``` -build firmware: + +Build firmware: + ``` cd app west build -b keychron -p -- -DSHIELD=keychron_b1_us -``` \ No newline at end of file +```