QMK MSYS 一键安装教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00900/article/details/147245940

QMK MSYS 一键安装教程

qmk_distro_msys A Windows one-click installer for the QMK CLI 项目地址: https://gitcode.com/gh_mirrors/qm/qmk_distro_msys

1. 项目目录结构及介绍

QMK MSYS 项目目录结构如下：

qmk_distro_msys/
├── .build/
├── .github/
├── docs/
├── installer/
│   └── ... # 安装程序相关文件
├── src/
│   └── ... # 源代码文件
├── .env
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── yarn.lock

.build/: 构建过程中产生的临时文件和中间文件存放目录。
.github/: GitHub Actions 工作流程文件和其他GitHub相关的配置文件。
docs/: 项目文档存放目录，包含项目的使用说明和帮助文档。
installer/: 包含Windows一键安装程序的文件。
src/: 源代码目录，包含QMK CLI的相关脚本和程序。
.env: 环境变量配置文件，用于存储项目运行所需的环境变量。
.gitignore: Git忽略文件列表，指定哪些文件和目录应该被Git仓库忽略。
LICENSE: 项目使用的许可证文件，本项目采用GPL-3.0协议。
README.md: 项目说明文件，通常包含项目的介绍、安装和使用说明。
package.json: Node.js项目配置文件，定义了项目的依赖和脚本。
yarn.lock: yarn包管理工具的锁定文件，确保项目依赖的一致性。

2. 项目的启动文件介绍

在QMK MSYS项目中，启动文件主要是位于installer/目录下的一键安装程序。这个安装程序是一个Windows可执行文件，用户双击后即可自动安装QMK CLI环境。

安装程序执行流程如下：

解压安装包到指定目录。
配置环境变量，确保QMK CLI可在命令行中直接使用。
创建桌面快捷方式，方便用户快速访问。

3. 项目的配置文件介绍

项目的配置文件主要包括.env和package.json。

.env: 此文件用于存储项目运行所需的环境变量，例如API密钥、数据库连接字符串等敏感信息。这个文件不会被提交到版本控制系统中，以保护敏感信息。
package.json: 这个文件是Node.js项目的核心配置文件，定义了项目的名称、版本、描述、依赖项、脚本等。在scripts部分，可以定义自定义脚本，例如启动服务、构建项目等操作。例如：

"scripts": {
  "setup": "qmk setup",
  "compile": "qmk compile"
}

这里定义了两个脚本，setup用于设置QMK环境，compile用于编译QMK固件。用户可以通过运行yarn setup和yarn compile来执行这些操作。

qmk_distro_msys A Windows one-click installer for the QMK CLI 项目地址: https://gitcode.com/gh_mirrors/qm/qmk_distro_msys