Rename hw75 to hw75_keyboard

.github/workflows/build.yml

@@ -13,9 +13,9 @@ jobs:
     strategy:
       matrix:
         include:
-          - { board: hw75@1.1,        keymap: hw75.keymap           }
-          - { board: hw75@1.2,        keymap: hw75.keymap           }
-          - { board: hw75_dynamic,    keymap: hw75_dynamic.keymap   }
+          - { board: hw75_keyboard@1.1, keymap: hw75_keyboard.keymap  }
+          - { board: hw75_keyboard@1.2, keymap: hw75_keyboard.keymap  }
+          - { board: hw75_dynamic,      keymap: hw75_dynamic.keymap   }
 
     steps:
       - name: Prepare variables

README.md

@@ -9,8 +9,8 @@ zmk-config for HelloWord HW-75 (瀚文 75)
 
 HW-75 由键盘主体 (Keyboard) 与扩展模块 (Dynamic) 组成。详细说明请见：
 
-* [Keyboard](config/boards/arm/hw75/)
-* [Dynamic](config/boards/arm/hw75_dynamic/)
+* [HW-75 Keyboard](config/boards/arm/hw75_keyboard/)
+* [HW-75 Dynamic](config/boards/arm/hw75_dynamic/)
 
 ## 相关链接
 

config/boards/arm/hw75_keyboard/CMakeLists.txt

@@ -0,0 +1,4 @@
+# Copyright (c) 2022-2023 XiNGRZ
+# SPDX-License-Identifier: MIT
+
+add_subdirectory_ifdef(CONFIG_BOARD_HW75_KEYBOARD app)

config/boards/arm/hw75_keyboard/Kconfig.board

@@ -0,0 +1,8 @@
+# HW-75 board configuration
+
+# Copyright (c) 2022-2023 XiNGRZ
+# SPDX-License-Identifier: MIT
+
+config BOARD_HW75_KEYBOARD
+	bool "HelloWord HW-75 Keyboard"
+	depends on SOC_STM32F103XB

config/boards/arm/hw75/Kconfig.defconfig → config/boards/arm/hw75_keyboard/Kconfig.defconfig

@@ -1,15 +1,15 @@
 # HW-75 board configuration
 
-# Copyright (c) 2022 The ZMK Contributors
+# Copyright (c) 2022-2023 XiNGRZ
 # SPDX-License-Identifier: MIT
 
-if BOARD_HW75
+if BOARD_HW75_KEYBOARD
 
 config BOARD
-	default "hw75"
+	default "hw75_keyboard"
 
 config ZMK_KEYBOARD_NAME
-	default "HelloWord HW-75"
+	default "HelloWord HW-75 Keyboard"
 
 config ZMK_USB
 	default y
@@ -43,4 +43,4 @@ config BUILD_OUTPUT_UF2_USE_FLASH_OFFSET
 
 endif # BUILD_OUTPUT_UF2
 
-endif # BOARD_HW75
+endif # BOARD_HW75_KEYBOARD

config/boards/arm/hw75/README.md → config/boards/arm/hw75_keyboard/README.md

@@ -9,8 +9,8 @@ HW-75 Keyboard
 
 | PCB 版本 | 文件前缀 | 备注 |
 |--------|--------------------|------|
-| Ver1.1 | `hw75@1.1-zmk` | [立创开源](https://oshwhub.com/pengzhihui/b11afae464c54a3e8d0f77e1f92dc7b7)版，大部分开源团使用的版本 |
-| Ver1.2 | `hw75@1.2-zmk` | Xikii 500 人试做团、哔哩哔哩会员购版 |
+| Ver1.1 | `hw75_keyboard@1.1-zmk` | [立创开源](https://oshwhub.com/pengzhihui/b11afae464c54a3e8d0f77e1f92dc7b7)版，大部分开源团使用的版本 |
+| Ver1.2 | `hw75_keyboard@1.2-zmk` | Xikii 500 人试做团、哔哩哔哩会员购版 |
 
 ## 烧录
 
@@ -25,7 +25,7 @@ HW-75 Keyboard
 
 ![keymap](keymap.png)
 
-本固件默认布局屏蔽了触摸条。如需更改布局，你可以将本仓库 Fork 到自己账号下之后使用 [ZMK Keymap Editor](https://nickcoutsos.github.io/keymap-editor/) 修改，或手动编辑 [`hw75.keymap`](/config/hw75.keymap) 文件。然后等待云端编译出新的固件。
+本固件默认布局屏蔽了触摸条。如需更改布局，你可以将本仓库 Fork 到自己账号下之后使用 [ZMK Keymap Editor](https://nickcoutsos.github.io/keymap-editor/) 修改，或手动编辑 [`hw75_keyboard.keymap`](/config/hw75_keyboard.keymap) 文件。然后等待云端编译出新的固件。
 
 ### 灯效
 
@@ -49,14 +49,14 @@ export GNUARMEMB_TOOLCHAIN_PATH=/path/to/gcc-arm-none-eabi-10.3-2021.10
 west init -l config
 west update
 west zephyr-export
-west build -s zmk/app -b hw75 -- -DZMK_CONFIG=$PWD/config
+west build -s zmk/app -b hw75_keyboard -- -DZMK_CONFIG=$PWD/config
 west flash
 ```
 
 默认会构建最新 PCB 版本的配置。如果你需要构建不同版本，可以使用下面的命令：
 
 ```sh
-west build -p -s zmk/app -b hw75@1.1 -- -DZMK_CONFIG=$PWD/config -DKEYMAP_FILE=$PWD/config/hw75.keymap
+west build -p -s zmk/app -b hw75_keyboard@1.1 -- -DZMK_CONFIG=$PWD/config -DKEYMAP_FILE=$PWD/config/hw75_keyboard.keymap
 ```
 
 ## 相关链接

config/boards/arm/hw75/board.cmake → config/boards/arm/hw75_keyboard/board.cmake

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 The ZMK Contributors
+# Copyright (c) 2022-2023 XiNGRZ
 # SPDX-License-Identifier: MIT
 
 board_runner_args(pyocd "--target=stm32f103c8")

config/boards/arm/hw75/hw75.dts → config/boards/arm/hw75_keyboard/hw75_keyboard.dts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 The ZMK Contributors
+ * Copyright (c) 2022-2023 XiNGRZ
  * SPDX-License-Identifier: MIT
  */
 
@@ -10,7 +10,7 @@
 #include <dt-bindings/zmk/matrix_transform.h>
 
 / {
-	model = "HelloWord HW-75";
+	model = "HelloWord HW-75 Keyboard";
 	compatible = "st,stm32f103";
 
 	chosen {

config/boards/arm/hw75_keyboard/hw75_keyboard.yaml

@@ -0,0 +1,7 @@
+identifier: hw75_keyboard
+name: HelloWord HW-75 Keyboard
+type: mcu
+arch: arm
+toolchain:
+  - zephyr
+  - gnuarmemb

config/boards/arm/hw75/hw75.zmk.yml → config/boards/arm/hw75_keyboard/hw75_keyboard.zmk.yml

@@ -1,6 +1,6 @@
 file_format: "1"
-id: hw75
-name: HelloWord HW-75
+id: hw75_keyboard
+name: HelloWord HW-75 Keyboard
 type: board
 arch: arm
 features:

config/boards/arm/hw75_keyboard/hw75_keyboard_1_1_0.conf

@@ -0,0 +1,2 @@
+# Copyright (c) 2022-2023 XiNGRZ
+# SPDX-License-Identifier: MIT

config/boards/arm/hw75_keyboard/hw75_keyboard_1_1_0.overlay

@@ -0,0 +1,4 @@
+/*
+ * Copyright (c) 2022-2023 XiNGRZ
+ * SPDX-License-Identifier: MIT
+ */

config/boards/arm/hw75_keyboard/hw75_keyboard_1_2_0.conf

@@ -0,0 +1,2 @@
+# Copyright (c) 2022-2023 XiNGRZ
+# SPDX-License-Identifier: MIT

config/boards/arm/hw75/hw75_1_2_0.overlay → config/boards/arm/hw75_keyboard/hw75_keyboard_1_2_0.overlay

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 The ZMK Contributors
+ * Copyright (c) 2022-2023 XiNGRZ
  * SPDX-License-Identifier: MIT
  */
 

config/boards/arm/hw75/hw75_defconfig → config/boards/arm/hw75_keyboard/hw75_keyboard_defconfig

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 The ZMK Contributors
+# Copyright (c) 2022-2023 XiNGRZ
 # SPDX-License-Identifier: MIT
 
 # SoC

config/boards/arm/hw75/revision.cmake → config/boards/arm/hw75_keyboard/revision.cmake

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 The ZMK Contributors
+# Copyright (c) 2022-2023 XiNGRZ
 # SPDX-License-Identifier: MIT
 
 board_check_revision(