《Oryx with Custom QMK 安装与配置指南》

《Oryx with Custom QMK 安装与配置指南》

oryx-with-custom-qmk Enhance your Oryx layout with advanced QMK features like Achordion, while retaining the ability to edit it via Oryx, then build it seamlessly with GitHub Actions 项目地址: https://gitcode.com/gh_mirrors/or/oryx-with-custom-qmk

1. 项目基础介绍

本项目是一个开源项目，旨在将Oryx的图形化键盘布局编辑功能与QMK的高级特性结合，使用户能够通过GitHub Actions自动化构建固件。项目主要使用Dockerfile进行自动化构建，以及一些C语言代码用于QMK的定制功能。

主要编程语言：

• C

2. 关键技术和框架

• Oryx：一个基于网页的键盘布局编辑器，可以图形化地编辑键盘布局。
• QMK（Quantum Mechanical Keyboard）：一个开源的键盘固件，支持键盘的高级定制功能。
• GitHub Actions：GitHub提供的持续集成和持续部署服务，用于自动化软件的构建、测试和部署。
• Docker：用于自动化应用部署的工具，可以将应用及其依赖环境打包成一个容器。

3. 安装和配置准备工作

在开始安装之前，请确保您的系统已经安装了以下软件：

• Git：用于版本控制和代码管理。
• Docker：用于容器化应用。
• GitHub账户：用于访问和操作GitHub仓库。

详细安装步骤

1. 克隆仓库

   打开命令行工具，使用以下命令克隆项目仓库到本地：

   git clone https://github.com/poulainpi/oryx-with-custom-qmk.git
   

2. 配置Docker

   确保Docker服务正在运行，可以通过命令行检查：

   docker --version
   

   如果Docker未安装或未运行，请根据官方文档进行安装和配置。

3. 初始化仓库

   在克隆的仓库目录下，初始化子模块（如果有的话）：

   git submodule update --init
   

4. 配置GitHub Actions

   打开项目的GitHub页面，进入Actions标签页，运行Fetch and build layout工作流。

   • 在工作流配置文件中，你可以设置默认的布局ID和键盘类型，这样每次就不需要手动输入。
   • 根据提示输入你的布局ID和键盘类型，然后运行工作流。

5. 编辑布局

   工作流运行结束后，会在仓库根目录生成一个包含布局的文件夹。你可以根据QMK文档编辑config.h、keymap.c和rules.mk文件来添加自定义的QMK特性。

6. 构建固件

   编辑完成后，提交并推送到main分支，然后再次运行GitHub Action来构建固件。构建完成后的固件会出现在工作流的artifacts中，可供下载。

7. 刷写固件

   下载固件后，使用Keymapp工具将固件刷写到键盘上。

完成以上步骤后，你就可以享受具有高级QMK特性的自定义键盘布局了。

oryx-with-custom-qmk Enhance your Oryx layout with advanced QMK features like Achordion, while retaining the ability to edit it via Oryx, then build it seamlessly with GitHub Actions 项目地址: https://gitcode.com/gh_mirrors/or/oryx-with-custom-qmk