Skip to content

Copy editing of the build instructions + plus correction of the patch file name #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PeterMortensen wants to merge 2 commits into
base: keychron_bpro
Choose a base branch
from
Open

Copy editing of the build instructions + plus correction of the patch file name #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d329c6
Update README.md
PeterMortensen Mar 9, 2025
6fd6003
Corrected the file name for the patch file (to use the actual file na…
PeterMortensen Mar 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
```