From 36bed36cd6830cc1428a3e6df19549e831f0b062 Mon Sep 17 00:00:00 2001 From: ymzcdg <49898694+ymzcdg@users.noreply.github.com> Date: Fri, 3 May 2019 21:18:20 +0800 Subject: [PATCH] getting_started_introduction.md ->zh-cn (#5767) translate getting_started_introduction.md into Mandarin Chinese --- docs/zh-cn/getting_started_introduction.md | 54 ++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 docs/zh-cn/getting_started_introduction.md diff --git a/docs/zh-cn/getting_started_introduction.md b/docs/zh-cn/getting_started_introduction.md new file mode 100644 index 000000000..36194c293 --- /dev/null +++ b/docs/zh-cn/getting_started_introduction.md @@ -0,0 +1,54 @@ +# ä»ç» + +æ¬é¡µè§£éäºä½¿ç¨QMKé¡¹ç®æéçåºæ¬ä¿¡æ¯ãå®å宿¨è½çç»ä½¿ç¨Unix shellï¼ä½æ¨ä¸çæCè¯è¨ä¹ä¸çæä½¿ç¨makeç¼è¯ã + +## åºæ¬QMKç»æ + +QMKæ¯[Jun Wako](https://github.com/tmk)ç[tmk_keyboard](https://github.com/tmk/tmk_keyboard)å·¥ç¨çä¸ä¸ªååãç»è¿æ´æ¹çTMKåå§ä»£ç æ¾å¨`tmk` æä»¶å¤¹ä¸ã QMKå¢å çæ°ä¸è¥¿å¯ä»¥å¨ `quantum` æä»¶å¤¹ä¸æ¾å°ã é®ç项ç®å¯ä»¥å¨ `handwired`ï¼æå¨é£çº¿ï¼ å `keyboard`ï¼PCBé®çï¼è¿ä¸¤ä¸ªæä»¶å¤¹æ¾å°ã + +### ç¨æ·ç©ºé´ç»æ + +å¨`users`æä»¶å¤¹éé¢çç®å½æ¯æ¯ä¸ªç¨æ·çç®å½ãè¿ä¸ªæä»¶å¤¹é颿¾çæ¯ç¨æ·ä»¬å¨ä¸åé®çé½è½ç¨å°ç代ç ã详è§[ç¨æ·ç©ºé´ç¹æ§](feature_userspace.md) + +### é®ç项ç®ç»æ + +å¨`keyboards`æä»¶å¤¹åä»çåæä»¶å¤¹`handwired`ä¸å°±æ¯å个é®çç项ç®äºï¼æ¯å¦`qmk_firmware/keyboards/clueboard`ãå é¨ç»æä¸å¦ä¸: + +* `keymaps/`: å¯ä»¥æå»ºçä¸åå¸å± +* `rules.mk`: ç¨æ¥è®¾ç½® "make" å½ä»¤é»è®¤é项çæä»¶ãå«ç´æ¥ç¼è¾è¿ä¸ªæä»¶,ä½ åºè¯¥ä½¿ç¨å ·ä½æä¸ªå¸å±ç `rules.mk`. +* `config.h`: ç¨äºè®¾ç½®é»è®¤ç¼è¯é项çæä»¶ãå«ç´æ¥ç¼è¾è¿ä¸ªæä»¶, ä½ åºè¯¥ä½¿ç¨å ·ä½æä¸ªå¸å±ç `config.h`. + +### å¸å±ç»æ + +å¨å个å¸å±çæä»¶å¤¹ï¼ä½ è½æ¾å°ä»¥ä¸æä»¶ãåªæ `keymap.c` æ¯å¿ è¦ç, å¦æå ¶ä»æä»¶æ¾ä¸å°å°±ä¼ç´æ¥éæ©é»è®¤é项ã + +* `config.h`: é ç½®å¸å±çé项 +* `keymap.c`: å¸å±çå ¨é¨ä»£ç , å¿ è¦æä»¶ +* `rules.mk`: 使è½çQMKç¹æ§ +* `readme.md`:ä»ç»ä½ çå¸å±,åè¯å«äººæä¹ä½¿ç¨ï¼éä¸åè½è¯´æã请å°å¾çä¸ä¼ å°imgurçå¾åºï¼è¯è 注ï¼imgurå¯è½å·²è¢«å¢ï¼ä¸ºäºæ¹ä¾¿å½äººè®¿é®ï¼å»ºè®®ä½¿ç¨å½å å¯ä»¥ç´æ¥è®¿é®çå¾åºï¼ã + +# `config.h` æä»¶ + +æä¸ä¸ªéè¦ç`config.h` ä½ç½®: + +* é®ç (`/keyboards/<keyboard>/config.h`) +* ç¨æ·ç©ºé´ (`/users/<user>/config.h`) +* å¸å± (`/keyboards/<keyboard>/keymaps/<keymap>/config.h`) + +æå»ºç³»ç»æç §ä¸è¿°é¡ºåºèªå¨è·åé ç½®æä»¶ã妿è¦è¦çç±ä¸ä¸ä¸ª `config.h` æåçè®¾ç½®ï¼æ¨éè¦é¦å ä¸ºè¦æ´æ¹ç设置å å«ä¸äºæ ·æ¿ä»£ç ã + +``` +#pragma once +``` + +è¦è¦çä¸ä¸ä¸ª `config.h` æåç设置ï¼ä½ è¦å `#undef` ç¶åå `#define` è¿ä¸ªè®¾ç½®. + +æ ·æ¿ä»£ç å设置çèµ·æ¥åè¿æ ·ï¼ + +``` +#pragma once + +// åä¸é¢é£æ ·è¦ç设置ï¼MY_SETTINGæçæ¯ä½ è¦è¦çç设置项ï¼! +#undef MY_SETTING +#define MY_SETTING 4 +``` -- 2.39.5