diff options
author | ymzcdg <49898694+ymzcdg@users.noreply.github.com> | 2019-04-24 03:37:20 +0800 |
---|---|---|
committer | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2019-04-23 12:37:20 -0700 |
commit | 7ae2ded5901bedf2014e254db2b5292cdb72ffe4 (patch) | |
tree | e42bf388c26b444eef38b4f41884a219221d3c01 /docs/zh-cn | |
parent | d48a5b29d764ee6ac925daf2500bb6101e8b23ca (diff) | |
download | qmk_firmware-7ae2ded5901bedf2014e254db2b5292cdb72ffe4.tar.gz qmk_firmware-7ae2ded5901bedf2014e254db2b5292cdb72ffe4.zip |
Translate docs into Chinese (#5693)
* Docs translate
Translate some docs to Standard Chinese for Chinese Developers.
* fix translate
fix translate
Diffstat (limited to 'docs/zh-cn')
-rw-r--r-- | docs/zh-cn/README.md | 32 | ||||
-rw-r--r-- | docs/zh-cn/_summary.md | 106 |
2 files changed, 138 insertions, 0 deletions
diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md new file mode 100644 index 000000000..9eb4ea777 --- /dev/null +++ b/docs/zh-cn/README.md | |||
@@ -0,0 +1,32 @@ | |||
1 | # QMK机械键盘固件 | ||
2 | |||
3 | [](https://github.com/qmk/qmk_firmware/tags) | ||
4 | [](https://travis-ci.org/qmk/qmk_firmware) | ||
5 | [](https://discord.gg/Uq7gcHh) | ||
6 | [](https://docs.qmk.fm) | ||
7 | [](https://github.com/qmk/qmk_firmware/pulse/monthly) | ||
8 | [](https://github.com/qmk/qmk_firmware/) | ||
9 | |||
10 | ## 什么是 QMK 固件? | ||
11 | |||
12 | QMK (*Quantum Mechanical Keyboard*) 是一个社区维护的开源软件,包括 QMK 固件, QMK 工具箱, qmk.fm网站, 和这些文档。QMK 固件是一个基于[tmk\_keyboard](http://github.com/tmk/tmk_keyboard)的键盘固件,它在爱特梅尔AVR微控制器实现一些有用的功能,确切地说, 是在 [OLKB product line](http://olkb.com), 在 [ErgoDox EZ](http://www.ergodox-ez.com) 键盘, 和 [Clueboard product line](http://clueboard.co/). 上。它被移植到使用ChibiOS的ARM芯片上. 它可以在飞线键盘或定制PCB键盘中发挥功能. | ||
13 | |||
14 | ## 如何得到它 | ||
15 | |||
16 | 如果你打算贡献布局, 键盘, 或者其他QMK特性, 一下是最简单的方法:[从Github获得repo分支](https://github.com/qmk/qmk_firmware#fork-destination-box), 并克隆你的repo到本地进行编辑,推送,然后从你的分支打开 [Pull Request](https://github.com/qmk/qmk_firmware/pulls). | ||
17 | |||
18 | 此外, 你也可以直接下载 ([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`). | ||
19 | |||
20 | ## 如何编译 | ||
21 | |||
22 | 在你能编译之前, 你需要[部署环境](getting_started_build_tools.md) 用于 AVR or/and ARM 开发。完成后, 你可以使用 `make` 命令来编译一个键盘和布局使用以下命令: | ||
23 | |||
24 | make planck/rev4:default | ||
25 | |||
26 | 这将建立 `planck`的`rev4` 修订版本并使用 `default`布局。并非所有键盘都有修订版本 (也叫做子项目或文件夹),在此情况下,修订版本可以省略,如下: | ||
27 | |||
28 | make preonic:default | ||
29 | |||
30 | ## 如何定制 | ||
31 | |||
32 | QMK 有许多 [特性](features.md)来探索,也有很多 [参考文档](http://docs.qmk.fm) 供您发掘。你可以通过修改 [布局](keymap.md)和[键码](keycodes.md)来利用许多特性。 | ||
diff --git a/docs/zh-cn/_summary.md b/docs/zh-cn/_summary.md new file mode 100644 index 000000000..df25a3ccd --- /dev/null +++ b/docs/zh-cn/_summary.md | |||
@@ -0,0 +1,106 @@ | |||
1 | * [完全菜鸟指南](newbs.md) | ||
2 | * [入门](newbs_getting_started.md) | ||
3 | * [构建你的第一个固件](newbs_building_firmware.md) | ||
4 | * [刷新固件](newbs_flashing.md) | ||
5 | * [测试和调试](newbs_testing_debugging.md) | ||
6 | * [Git最佳实践](newbs_best_practices.md) | ||
7 | * [学习资源](newbs_learn_more_resources.md) | ||
8 | |||
9 | * [QMK基础](README.md) | ||
10 | * [QMK 简介](getting_started_introduction.md) | ||
11 | * [贡献 QMK](contributing.md) | ||
12 | * [如何使用Github](getting_started_github.md) | ||
13 | * [获得帮助](getting_started_getting_help.md) | ||
14 | |||
15 | * [问题解答](faq.md) | ||
16 | * [一般问题](faq_general.md) | ||
17 | * [构建/编译QMK](faq_build.md) | ||
18 | * [调试/故障排除 QMK](faq_debug.md) | ||
19 | * [键盘布局](faq_keymap.md) | ||
20 | |||
21 | * 详细指南 | ||
22 | * [安装构建工具](getting_started_build_tools.md) | ||
23 | * [流浪者指南](getting_started_vagrant.md) | ||
24 | * [构建/编译指令](getting_started_make_guide.md) | ||
25 | * [刷新固件](flashing.md) | ||
26 | * [定制功能](custom_quantum_functions.md) | ||
27 | * [布局概述](keymap.md) | ||
28 | |||
29 | * [硬件](hardware.md) | ||
30 | * [AVR 处理器](hardware_avr.md) | ||
31 | * [驱动](hardware_drivers.md) | ||
32 | |||
33 | * 参考 | ||
34 | * [键盘指南](hardware_keyboard_guidelines.md) | ||
35 | * [配置选项](config_options.md) | ||
36 | * [键码](keycodes.md) | ||
37 | * [记录最佳实践](documentation_best_practices.md) | ||
38 | * [文档指南](documentation_templates.md) | ||
39 | * [词汇表](reference_glossary.md) | ||
40 | * [单元测试](unit_testing.md) | ||
41 | * [有用的功能](ref_functions.md) | ||
42 | * [配置器支持](reference_configurator_support.md) | ||
43 | * [info.json 格式](reference_info_json.md) | ||
44 | |||
45 | * [特性](features.md) | ||
46 | * [基本键码](keycodes_basic.md) | ||
47 | * [US ANSI 控制键](keycodes_us_ansi_shifted.md) | ||
48 | * [量子键码](quantum_keycodes.md) | ||
49 | * [高级键码](feature_advanced_keycodes.md) | ||
50 | * [音频](feature_audio.md) | ||
51 | * [自动控制](feature_auto_shift.md) | ||
52 | * [背光](feature_backlight.md) | ||
53 | * [蓝牙](feature_bluetooth.md) | ||
54 | * [Bootmagic](feature_bootmagic.md) | ||
55 | * [组合](feature_combo) | ||
56 | * [命令](feature_command.md) | ||
57 | * [动态宏指令](feature_dynamic_macros.md) | ||
58 | * [编码器](feature_encoders.md) | ||
59 | * [Grave Escape](feature_grave_esc.md) | ||
60 | * [键锁](feature_key_lock.md) | ||
61 | * [层](feature_layouts.md) | ||
62 | * [引导键](feature_leader_key.md) | ||
63 | * [LED 阵列](feature_led_matrix.md) | ||
64 | * [宏指令](feature_macros.md) | ||
65 | * [鼠标键](feature_mouse_keys.md) | ||
66 | * [一键功能](feature_advanced_keycodes.md#one-shot-keys) | ||
67 | * [指针设备](feature_pointing_device.md) | ||
68 | * [PS/2 鼠标](feature_ps2_mouse.md) | ||
69 | * [RGB 光](feature_rgblight.md) | ||
70 | * [RGB 矩阵](feature_rgb_matrix.md) | ||
71 | * [空格候补换挡](feature_space_cadet_shift.md) | ||
72 | * [空格候补换挡回车](feature_space_cadet_shift_enter.md) | ||
73 | * [速录机](feature_stenography.md) | ||
74 | * [换手](feature_swap_hands.md) | ||
75 | * [踢踏舞](feature_tap_dance.md) | ||
76 | * [终端](feature_terminal.md) | ||
77 | * [热敏打印机](feature_thermal_printer.md) | ||
78 | * [Unicode](feature_unicode.md) | ||
79 | * [用户空间](feature_userspace.md) | ||
80 | * [速度键](feature_velocikey.md) | ||
81 | |||
82 | * 针对制造者和定制者 | ||
83 | * [飞线指南](hand_wire.md) | ||
84 | * [ISP 刷新指南](isp_flashing_guide.md) | ||
85 | * [ARM 调试指南](arm_debugging.md) | ||
86 | * [I2C 驱动](i2c_driver.md) | ||
87 | * [GPIO 控制器](internals_gpio_control.md) | ||
88 | * [Proton C 转换](proton_c_conversion.md) | ||
89 | |||
90 | * 深入了解 | ||
91 | * [键盘如何工作](how_keyboards_work.md) | ||
92 | * [理解 QMK](understanding_qmk.md) | ||
93 | |||
94 | * 其他话题 | ||
95 | * [使用Eclipse开发QMK](other_eclipse.md) | ||
96 | * [使用VSCode开发QMK](other_vscode.md) | ||
97 | * [支持](support.md) | ||
98 | |||
99 | * QMK 内构 (正在编写) | ||
100 | * [定义](internals_defines.md) | ||
101 | * [输入回调寄存器](internals_input_callback_reg.md) | ||
102 | * [Midi 设备](internals_midi_device.md) | ||
103 | * [Midi 设备设置过程](internals_midi_device_setup_process.md) | ||
104 | * [Midi 工具库](internals_midi_util.md) | ||
105 | * [发送函数](internals_send_functions.md) | ||
106 | * [Sysex 工具](internals_sysex_tools.md) | ||