From 2fb981336c8dd101325981ad8f43c6986b0eef37 Mon Sep 17 00:00:00 2001 From: peepeetee <43021794+peepeetee@users.noreply.github.com> Date: Thu, 9 Dec 2021 18:46:19 +0800 Subject: [PATCH 1/2] Update Simplified Chinese readme.md to match up with the current English one --- docs/zh-cn/README.md | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md index b42818d582f2..41e2fcfed82b 100644 --- a/docs/zh-cn/README.md +++ b/docs/zh-cn/README.md @@ -1,31 +1,44 @@ # QMK机械键盘固件 [![当前版本](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags) -[![异议](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh) +[![discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh) [![文档状态](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm) [![GitHub贡献者](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly) [![GitHub分支](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/) ## 什么是 QMK 固件? -QMK (*Quantum Mechanical Keyboard*) 是一个社区维护的开源软件，包括 QMK 固件, QMK 工具箱, qmk.fm网站, 和这些文档。QMK 固件是一个基于[tmk\_keyboard](https://github.com/tmk/tmk_keyboard)的键盘固件，它在爱特梅尔AVR微控制器实现一些有用的功能,确切地说, 是在 [OLKB product line](https://olkb.com), 在 [ErgoDox EZ](https://www.ergodox-ez.com) 键盘, 和 [Clueboard product line](https://clueboard.co/). 上。它被移植到使用ChibiOS的ARM芯片上. 它可以在飞线键盘或定制PCB键盘中发挥功能. +QMK (*Quantum Mechanical Keyboard*) 是一个开源软件社区。该社区支持像键盘，鼠标，MIDI设备的各种电子输入设备。社区的核心团体维护 [QMK 固件](https://github.com/qmk/qmk_firmware), [QMK 工具箱](https://github.com/qmk/qmk_toolbox), [qmk.fm网站](https://qmk.fm), 和这些文档。 -## 如何得到它 +## 如何入门 -如果你打算贡献布局, 键盘, 或者其他QMK特性, 一下是最简单的方法：[从GitHub获得repo分支](https://github.com/qmk/qmk_firmware#fork-destination-box), 并克隆你的repo到本地进行编辑，推送，然后从你的分支打开 [Pull Request](https://github.com/qmk/qmk_firmware/pulls). +
-此外, 你也可以直接下载 ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), 或者从git克隆 (`git@github.com:qmk/qmk_firmware.git`), 或 https (`https://github.com/qmk/qmk_firmware.git`). +?> **基本** [QMK Configurator](zh-cn/newbs_building_firmware_configurator.md)
+易用的图形界面，无需编程知识即可使用。 -## 如何编译 +?> **进阶** [使用源码](zh-cn/newbs.md)
+更强大，但需要一些编程知识 -在你能编译之前, 你需要[部署环境](zh-cn/getting_started_build_tools.md) 用于 AVR or/and ARM 开发。完成后, 你可以使用 `make` 命令来编译一个键盘和布局使用以下命令: +
- make planck/rev4:default -这将建立 `planck`的`rev4` 修订版本并使用 `default`布局。并非所有键盘都有修订版本 (也叫做子项目或文件夹)，在此情况下，修订版本可以省略，如下: +## 如何定制 - make preonic:default +QMK 有许多功能去探索，也有很多参考文档供您发掘。你可以通过修改 [布局](zh-cn/keymap.md)和[键码](zh-cn/keycodes.md)来利用大多数功能。 -## 如何定制 +## 需要帮助？ + +请移步[支持页](zh-cn/support.md) + +## 给QMK做贡献 + +给QMK做贡献的方法很多，最简单的方法便是去使用它以及把它介绍给你的朋友。 -QMK 有许多 [特性](zh-cn/features.md)来探索，也有很多 [参考文档](https://docs.qmk.fm) 供您发掘。你可以通过修改 [布局](zh-cn/keymap.md)和[键码](zh-cn/keycodes.md)来利用许多特性。 +* 在论坛和聊天室帮助需要帮助的人： + * [/r/olkb](https://www.reddit.com/r/olkb/) + * [Discord 服务器](https://discord.gg/Uq7gcHh) +* 点击在页面底部的 "Edit This Page"，编辑这些文档 +* [把这些文档翻译成你的语言](translating.md) +* [报告问题](https://github.com/qmk/qmk_firmware/issues/new/choose) +* [新增Pull Request](contributing.md) From b3b9facac188ea15149fc7737ebf3e19843de4e5 Mon Sep 17 00:00:00 2001 From: peepeetee Date: Fri, 17 Dec 2021 09:38:12 +0800 Subject: [PATCH 2/2] README.md included in @epicskandar's #14924 --- docs/zh-cn/README.md | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md index 41e2fcfed82b..3327b9cfb485 100644 --- a/docs/zh-cn/README.md +++ b/docs/zh-cn/README.md @@ -1,4 +1,4 @@ -# QMK机械键盘固件 +# Quantum Mechanical Keyboard固件 [![当前版本](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags) [![discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh) @@ -8,37 +8,36 @@ ## 什么是 QMK 固件? -QMK (*Quantum Mechanical Keyboard*) 是一个开源软件社区。该社区支持像键盘，鼠标，MIDI设备的各种电子输入设备。社区的核心团体维护 [QMK 固件](https://github.com/qmk/qmk_firmware), [QMK 工具箱](https://github.com/qmk/qmk_toolbox), [qmk.fm网站](https://qmk.fm), 和这些文档。 +QMK (*Quantum Mechanical Keyboard*) 是一个社区维护的用于开发计算机输入设备的开源软件。社区专注像键盘，鼠标，MIDI设备的各种电子输入设备。社区内的核心小组成员维护[QMK固件](https://github.com/qmk/qmk_firmware)，[QMK配置器](https://config.qmk.fm)，[QMK工具箱](https://github.com/qmk/qmk_toolbox)，[qmk.fm](https://qmk.fm)，并与各位社区成员维护这份文档。 ## 如何入门
-?> **基本** [QMK Configurator](zh-cn/newbs_building_firmware_configurator.md)
-易用的图形界面，无需编程知识即可使用。 +?> **基础方式** [QMK配置器](zh-cn/newbs_building_firmware_configurator.md)
+用户友好的图形界面工具，无需具备编程知识基础。 -?> **进阶** [使用源码](zh-cn/newbs.md)
-更强大，但需要一些编程知识 +?> **进阶方式** [基于源代码](zh-cn/newbs.md)
+功能更强大，但门槛较高。
+## 个性化定制 -## 如何定制 - -QMK 有许多功能去探索，也有很多参考文档供您发掘。你可以通过修改 [布局](zh-cn/keymap.md)和[键码](zh-cn/keycodes.md)来利用大多数功能。 +QMK提供了很多功能，对应着很多可供浏览的配套文档。大部分功能都是通过修改[键映射](zh-cn/keymap.md)及[键码](zh-cn/keycodes.md)实现的。 ## 需要帮助？ -请移步[支持页](zh-cn/support.md) +请查阅[寻求帮助页面](zh-cn/support.md)以了解如何获取QMK使用方法的帮助。 -## 给QMK做贡献 +## 回馈社区 -给QMK做贡献的方法很多，最简单的方法便是去使用它以及把它介绍给你的朋友。 +有多种回馈社区的方法，最简单的方法是开始使用QMK并向你的朋友们推荐它。 -* 在论坛和聊天室帮助需要帮助的人： +* 可以在我们的论坛及聊天室进行互助： * [/r/olkb](https://www.reddit.com/r/olkb/) - * [Discord 服务器](https://discord.gg/Uq7gcHh) -* 点击在页面底部的 "Edit This Page"，编辑这些文档 -* [把这些文档翻译成你的语言](translating.md) -* [报告问题](https://github.com/qmk/qmk_firmware/issues/new/choose) -* [新增Pull Request](contributing.md) + * [Discord服务器](https://discord.gg/Uq7gcHh) +* 点击页面下方的"Edit This Page"，可以对文档提供贡献。 +* [将这份文档翻译为你的语言](zh-cn/translating.md) +* [上报bug](https://github.com/qmk/qmk_firmware/issues/new/choose) +* [发起Pull Request](zh-cn/contributing.md)