Taira Keyboard 项目使用教程

Taira Keyboard 项目使用教程

taira-keyboard A wireless low-profile split mechanical keyboard with 66 keys inspired by the ErgoDash and Corne Chocolate 项目地址: https://gitcode.com/gh_mirrors/ta/taira-keyboard

1. 项目的目录结构及介绍

taira-keyboard/
├── docs/
│   ├── BUILDGUIDE.md
│   └── README.md
├── pcb/
├── plates/
├── .gitignore
├── .markdownlint.yaml
├── .prettierrc.yaml
├── BUILDGUIDE.md
├── LICENSE
├── README.md
├── package.json
└── yarn.lock

• docs/: 包含项目的构建指南和README文件。

  • BUILDGUIDE.md: 详细的构建指南，指导用户如何组装和配置Taira Keyboard。
  • README.md: 项目的基本介绍和使用说明。

• pcb/: 包含键盘的PCB设计文件。

• plates/: 包含键盘的板材设计文件。

• .gitignore: Git忽略文件，指定哪些文件和目录不应被版本控制。

• .markdownlint.yaml: Markdown文件的格式检查配置。

• .prettierrc.yaml: Prettier代码格式化配置。

• BUILDGUIDE.md: 构建指南，详细说明如何组装键盘。

• LICENSE: 项目的开源许可证，采用MIT许可证。

• README.md: 项目的主README文件，包含项目的基本信息和使用说明。

• package.json: Node.js项目的配置文件，包含项目的依赖和脚本。

• yarn.lock: Yarn包管理器的锁定文件，确保依赖版本的一致性。

2. 项目的启动文件介绍

Taira Keyboard项目本身是一个硬件项目，没有传统意义上的“启动文件”。项目的核心在于硬件设计和固件配置。用户需要按照BUILDGUIDE.md中的步骤进行硬件组装，并使用ZMK固件进行配置。

3. 项目的配置文件介绍

3.1 package.json

package.json是Node.js项目的配置文件，包含项目的元数据和依赖信息。对于Taira Keyboard项目，package.json主要用于管理开发过程中使用的工具和依赖。

{
  "name": "taira-keyboard",
  "version": "1.0.0",
  "description": "A wireless low-profile split mechanical keyboard with 66 keys inspired by the ErgoDash and Corne Chocolate",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Sven Grunewaldt",
  "license": "MIT",
  "dependencies": {
    "prettier": "^2.0.0"
  }
}

3.2 .prettierrc.yaml

.prettierrc.yaml是Prettier代码格式化工具的配置文件，用于统一代码风格。

printWidth: 80
tabWidth: 2
useTabs: false
semi: true
singleQuote: true
trailingComma: 'es5'
bracketSpacing: true
jsxBracketSameLine: false
arrowParens: 'always'

3.3 .markdownlint.yaml

.markdownlint.yaml是Markdown文件的格式检查配置，确保文档的一致性和规范性。

MD013: false
MD033: false
MD041: false

3.4 BUILDGUIDE.md

BUILDGUIDE.md是项目的构建指南，详细说明如何组装和配置Taira Keyboard。用户需要按照其中的步骤进行硬件组装，并使用ZMK固件进行配置。

3.5 README.md

README.md是项目的主README文件，包含项目的基本信息和使用说明。用户可以通过阅读该文件了解项目的基本情况和使用方法。

# Taira Keyboard

A wireless low-profile split mechanical keyboard with 66 keys inspired by the ErgoDash and Corne Chocolate.

## Features

- Fully wireless via Bluetooth
- Runs ZMK on two nice!nanos
- Uses Kailh Choc V1 switches
- 18x19mm grid layout

## Build Guide

Follow the [BUILDGUIDE.md](docs/BUILDGUIDE.md) for detailed instructions on how to build your own Taira Keyboard.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

通过以上内容，用户可以了解Taira Keyboard项目的目录结构、配置文件及其作用，并按照构建指南进行硬件组装和配置。

taira-keyboard A wireless low-profile split mechanical keyboard with 66 keys inspired by the ErgoDash and Corne Chocolate 项目地址: https://gitcode.com/gh_mirrors/ta/taira-keyboard