diff --git a/LICENSE b/LICENSE index 261eeb9..12f3d5f 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [yyyy] [name of copyright owner] + Copyright [2021-2022] [Sipeed Ltd] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index dba5f26..78b3aa9 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,104 @@ -# sipeed_keyboard -![FirmwareCI](https://github.com/sipeed/sipeed_keyboard/actions/workflows/build_firmware.yml/badge.svg)
-sipeed opensource mechanical keyboard make with BL706
+sipeed_keyboard +==== + +![FirmwareCI](https://github.com/sipeed/sipeed_keyboard/actions/workflows/build_firmware.yml/badge.svg) + +sipeed opensource mechanical keyboard(SMK) made with BL706 + 矽π 开源双模机械键盘 +![](./assets/SMK68_1.png) +![](./assets/SMK68_3.png) + +## 特性 + +* 主控使用 BL706, 使用 `RISC-V` 核, 支持蓝牙和 `USB`,[代码开源](https://github.com/Sipeed/sipeed_keyboard) +* 键轴支持热插拔 + + +## 使用指导 + +如果你想快速用上这款开源键盘: + +* 从 [Sipeed](https://sipeed.taobao.com) 购买 SMK68 键盘底板(可能需要询问商家),不包含键帽和键轴 +* 自行购买键轴和键帽(68键),组装成完整键盘 +* 出厂自带了固件,可以插上 USB 测试按键是否均能响应,至此键盘已经可以正常使用 +* 更新固件:在 [release](https://github.com/sipeed/sipeed_keyboard/releases) 页面下载最新固件,按照[固件升级方法]()升级固件 +* 使用软件自定义按键(待做) + +如果你想更深入地定制你的键盘, 本项目下包含了 +* 键盘硬件(PCB 板)原理图 +* 键盘固件源码 +* 软件源码(运行在电脑上) + +只需要克隆本项目到本地,根据你的喜好进行修改即可,也欢迎参与贡献,大家一起改进体验! ## 目录结构 + ``` -./ -├── LICENSE +├── LICENSE // 开源证书 ├── README.md -├── firmware // 存放键盘固件 -├── hardware // 硬件设计 -├── software // 上位机软件 -├── teamworks // 贡献记录 -└── tools // 工具 +├── firmware // 存放键盘固件 +├── hardware // 硬件设计 +├── software // 上位机软件 +├── teamworks // 贡献记录 +└── tools // 工具 ``` ## 构建键盘固件 -1. 参考[开发环境搭建指南](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/index.html) + +* 参考[开发环境搭建指南](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/index.html) + +* 克隆仓库到本地(需要更新子模块) ```sh git clone https://github.com/sipeed/sipeed_keyboard.git cd sipeed_keyboard git submodule init git submodule update +``` + +* 编译固件 + +``` cd firmware/bl_mcu_sdk make build BOARD=sipeed_keyboard APP=sipeed_keyboard_68 APP_DIR=../keyboard - ``` -## 交流QQ群 -![](https://img.hackx.cc/img/qrcode_1626271263202.jpg) + +* 烧录固件到键盘 + +根据 [开发环境搭建指南](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/index.html) 里面所述进行烧录 + +> 以 Linux 为例: +> * 按住键盘的 BOOT 按键 +> * 然后按 RESET 按键 +> * 片刻后松开两个按键(松开不论顺序) +> * 使用`ls /dev/tty*` 命令查看到出现的串口设备,比如叫`/dev/ttyACM0` +> * 然后再`firmware/bl_mcu_sdk`目录下执行烧录命令 +> ``` +> make download INTERFACE=uart COMx=/dev/ttyACM0 +> ``` + +烧录结束后需要手动按一下 RESET 按键来重启键盘 + +## 开源证书 + +代码采用 [Apache 2.0](./LICENSE) 开源协议, 参与贡献后可以在修改的文件头注释标明修改和日期 + +## 贡献者 + + + + + + +## 参与贡献 + +* 项目进度可以在 [sipeed_keyboard/projects](https://github.com/sipeed/sipeed_keyboard/projects) 看到, 为领取的任务可以领取一起做~ +* 可以发起[issues](https://github.com/sipeed/sipeed_keyboard/issues),做好了提交 `Pulll Request` +* 可以加 QQ 群参与讨论( 933963409 ) + + + + diff --git a/assets/SMK68_1.png b/assets/SMK68_1.png new file mode 100644 index 0000000..6cde1bb Binary files /dev/null and b/assets/SMK68_1.png differ diff --git a/assets/SMK68_2.png b/assets/SMK68_2.png new file mode 100644 index 0000000..fc313c6 Binary files /dev/null and b/assets/SMK68_2.png differ diff --git a/assets/SMK68_3.png b/assets/SMK68_3.png new file mode 100644 index 0000000..2143d0a Binary files /dev/null and b/assets/SMK68_3.png differ