diff options
author | Ryan Caltabiano <rcalt2vt@gmail.com> | 2019-05-04 12:02:02 -0500 |
---|---|---|
committer | Drashna Jaelre <drashna@live.com> | 2019-05-04 10:17:46 -0700 |
commit | 3a7c65b42442971bcb3369cc9dc3615b6aad1383 (patch) | |
tree | d1a67b45d911006a952aed68dafef9b4c08044b7 /docs/zh-cn/getting_started_introduction.md | |
parent | 9f2fc1179aa39a2728a9606909a2a2795313d8d5 (diff) | |
download | qmk_firmware-3a7c65b42442971bcb3369cc9dc3615b6aad1383.tar.gz qmk_firmware-3a7c65b42442971bcb3369cc9dc3615b6aad1383.zip |
fix line endings
Diffstat (limited to 'docs/zh-cn/getting_started_introduction.md')
-rw-r--r-- | docs/zh-cn/getting_started_introduction.md | 108 |
1 files changed, 54 insertions, 54 deletions
diff --git a/docs/zh-cn/getting_started_introduction.md b/docs/zh-cn/getting_started_introduction.md index 36194c293..dcd0b72a5 100644 --- a/docs/zh-cn/getting_started_introduction.md +++ b/docs/zh-cn/getting_started_introduction.md | |||
@@ -1,54 +1,54 @@ | |||
1 | # 介绍 | 1 | # 介绍 |
2 | 2 | ||
3 | 本页解释了使用QMK项目所需的基本信息。它假定您能熟练使用Unix shell,但您不熟悉C语言也不熟悉使用make编译。 | 3 | 本页解释了使用QMK项目所需的基本信息。它假定您能熟练使用Unix shell,但您不熟悉C语言也不熟悉使用make编译。 |
4 | 4 | ||
5 | ## 基本QMK结构 | 5 | ## 基本QMK结构 |
6 | 6 | ||
7 | QMK是[Jun Wako](https://github.com/tmk)的[tmk_keyboard](https://github.com/tmk/tmk_keyboard)工程的一个分叉。经过更改的TMK原始代码放在`tmk` 文件夹中。 QMK增加的新东西可以在 `quantum` 文件夹中找到。 键盘项目可以在 `handwired`(手动飞线) 和 `keyboard`(PCB键盘)这两个文件夹找到。 | 7 | QMK是[Jun Wako](https://github.com/tmk)的[tmk_keyboard](https://github.com/tmk/tmk_keyboard)工程的一个分叉。经过更改的TMK原始代码放在`tmk` 文件夹中。 QMK增加的新东西可以在 `quantum` 文件夹中找到。 键盘项目可以在 `handwired`(手动飞线) 和 `keyboard`(PCB键盘)这两个文件夹找到。 |
8 | 8 | ||
9 | ### 用户空间结构 | 9 | ### 用户空间结构 |
10 | 10 | ||
11 | 在`users`文件夹里面的目录是每个用户的目录。这个文件夹里面放的是用户们在不同键盘都能用到的代码。详见[用户空间特性](feature_userspace.md) | 11 | 在`users`文件夹里面的目录是每个用户的目录。这个文件夹里面放的是用户们在不同键盘都能用到的代码。详见[用户空间特性](feature_userspace.md) |
12 | 12 | ||
13 | ### 键盘项目结构 | 13 | ### 键盘项目结构 |
14 | 14 | ||
15 | 在`keyboards`文件夹和他的子文件夹`handwired`中就是各个键盘的项目了,比如`qmk_firmware/keyboards/clueboard`。内部结构与如下: | 15 | 在`keyboards`文件夹和他的子文件夹`handwired`中就是各个键盘的项目了,比如`qmk_firmware/keyboards/clueboard`。内部结构与如下: |
16 | 16 | ||
17 | * `keymaps/`: 可以构建的不同布局 | 17 | * `keymaps/`: 可以构建的不同布局 |
18 | * `rules.mk`: 用来设置 "make" 命令默认选项的文件。别直接编辑这个文件,你应该使用具体某个布局的 `rules.mk`. | 18 | * `rules.mk`: 用来设置 "make" 命令默认选项的文件。别直接编辑这个文件,你应该使用具体某个布局的 `rules.mk`. |
19 | * `config.h`: 用于设置默认编译选项的文件。别直接编辑这个文件, 你应该使用具体某个布局的 `config.h`. | 19 | * `config.h`: 用于设置默认编译选项的文件。别直接编辑这个文件, 你应该使用具体某个布局的 `config.h`. |
20 | 20 | ||
21 | ### 布局结构 | 21 | ### 布局结构 |
22 | 22 | ||
23 | 在各个布局的文件夹,你能找到以下文件。只有 `keymap.c` 是必要的, 如果其他文件找不到就会直接选择默认选项。 | 23 | 在各个布局的文件夹,你能找到以下文件。只有 `keymap.c` 是必要的, 如果其他文件找不到就会直接选择默认选项。 |
24 | 24 | ||
25 | * `config.h`: 配置布局的选项 | 25 | * `config.h`: 配置布局的选项 |
26 | * `keymap.c`: 布局的全部代码, 必要文件 | 26 | * `keymap.c`: 布局的全部代码, 必要文件 |
27 | * `rules.mk`: 使能的QMK特性 | 27 | * `rules.mk`: 使能的QMK特性 |
28 | * `readme.md`:介绍你的布局,告诉别人怎么使用,附上功能说明。请将图片上传到imgur等图床(译者注:imgur可能已被墙,为了方便国人访问,建议使用国内可以直接访问的图床)。 | 28 | * `readme.md`:介绍你的布局,告诉别人怎么使用,附上功能说明。请将图片上传到imgur等图床(译者注:imgur可能已被墙,为了方便国人访问,建议使用国内可以直接访问的图床)。 |
29 | 29 | ||
30 | # `config.h` 文件 | 30 | # `config.h` 文件 |
31 | 31 | ||
32 | 有三个重要的`config.h` 位置: | 32 | 有三个重要的`config.h` 位置: |
33 | 33 | ||
34 | * 键盘 (`/keyboards/<keyboard>/config.h`) | 34 | * 键盘 (`/keyboards/<keyboard>/config.h`) |
35 | * 用户空间 (`/users/<user>/config.h`) | 35 | * 用户空间 (`/users/<user>/config.h`) |
36 | * 布局 (`/keyboards/<keyboard>/keymaps/<keymap>/config.h`) | 36 | * 布局 (`/keyboards/<keyboard>/keymaps/<keymap>/config.h`) |
37 | 37 | ||
38 | 构建系统按照上述顺序自动获取配置文件。如果要覆盖由上一个 `config.h` 所做的设置,您需要首先为要更改的设置包含一些样板代码。 | 38 | 构建系统按照上述顺序自动获取配置文件。如果要覆盖由上一个 `config.h` 所做的设置,您需要首先为要更改的设置包含一些样板代码。 |
39 | 39 | ||
40 | ``` | 40 | ``` |
41 | #pragma once | 41 | #pragma once |
42 | ``` | 42 | ``` |
43 | 43 | ||
44 | 要覆盖上一个 `config.h` 所做的设置,你要先 `#undef` 然后再 `#define` 这个设置. | 44 | 要覆盖上一个 `config.h` 所做的设置,你要先 `#undef` 然后再 `#define` 这个设置. |
45 | 45 | ||
46 | 样板代码和设置看起来像这样: | 46 | 样板代码和设置看起来像这样: |
47 | 47 | ||
48 | ``` | 48 | ``` |
49 | #pragma once | 49 | #pragma once |
50 | 50 | ||
51 | // 像下面那样覆盖设置(MY_SETTING指的是你要覆盖的设置项)! | 51 | // 像下面那样覆盖设置(MY_SETTING指的是你要覆盖的设置项)! |
52 | #undef MY_SETTING | 52 | #undef MY_SETTING |
53 | #define MY_SETTING 4 | 53 | #define MY_SETTING 4 |
54 | ``` | 54 | ``` |