QMK Keymap 项目下载及安装教程

1. 项目介绍

QMK Keymap 是一个开源项目，旨在为 Quantum Mechanical Keyboard (QMK) 提供可重用的键盘映射和功能库。该项目由 Pascal Getreuer 开发，适用于 Dactyl Ergodox、ZSA Moonlander 和 ZSA Voyager 等键盘。QMK Keymap 不仅提供了个性化的键盘映射，还包含多个用户空间功能库，如 Achordion、Custom Shift Keys、Mouse Turbo Click 等，极大地增强了键盘的功能性和可定制性。

2. 项目下载位置

要下载 QMK Keymap 项目，请使用以下命令：

git clone https://github.com/getreuer/qmk-keymap.git

3. 项目安装环境配置

在安装 QMK Keymap 之前，需要确保系统中已安装 QMK 固件开发环境。以下是配置步骤：

3.1 安装 QMK 工具箱

首先，下载并安装 QMK 工具箱。QMK 工具箱是一个图形化工具，用于编译和刷写 QMK 固件。

3.2 安装 QMK CLI

接下来，安装 QMK CLI（命令行界面）。QMK CLI 是一个强大的工具，用于管理和编译 QMK 固件。

python3 -m pip install qmk

3.3 初始化 QMK 环境

使用 QMK CLI 初始化 QMK 环境：

qmk setup

4. 项目安装方式

安装 QMK Keymap 项目的步骤如下：

4.1 克隆项目

首先，克隆 QMK Keymap 项目到本地：

git clone https://github.com/getreuer/qmk-keymap.git

4.2 配置用户覆盖目录

运行以下命令，配置 QMK 用户覆盖目录：

qmk config user.overlay_dir="$(realpath path/to/qmk-keymap)"

4.3 编译并刷写固件

根据使用的键盘类型，选择相应的命令编译并刷写固件：

• Dactyl Ergodox:

  qmk flash -kb handwired/dactyl_promicro -km getreuer
  

• ZSA Moonlander:

  qmk flash -kb zsa/moonlander -km getreuer
  

• ZSA Voyager:

  qmk flash -kb zsa/voyager -km getreuer
  

5. 项目处理脚本

QMK Keymap 项目包含多个处理脚本，用于自动化编译和刷写过程。以下是一些常用的脚本：

5.1 compile.sh

该脚本用于编译 QMK Keymap 项目：

#!/bin/bash
qmk compile -kb handwired/dactyl_promicro -km getreuer

5.2 flash.sh

该脚本用于刷写编译后的固件：

#!/bin/bash
qmk flash -kb handwired/dactyl_promicro -km getreuer

通过这些脚本，可以简化 QMK Keymap 项目的管理和部署过程。

---

以上是 QMK Keymap 项目的下载及安装教程。希望这篇文章能帮助你顺利完成项目的安装和配置。