mirror of
https://github.com/openstenoproject/qmk
synced 2024-11-11 02:59:09 +00:00
d5a06aec83
* add zh-cn readme * edit readme * Round 1 of edits - Mandarin translation of QMK products is off, best to use the English name. - Fix some terminology and grammar. * trying re-translating the first paragraph * add fallback langurages * Create LANGS.md * Rename docs/zh-cn/README.md to docs/zh/README.md * Update LANGS.md * Update index.html
32 lines
2.4 KiB
Markdown
32 lines
2.4 KiB
Markdown
# QMK鍵盤固件
|
||
|
||
[](https://github.com/qmk/qmk_firmware/tags)
|
||
[](https://travis-ci.org/qmk/qmk_firmware)
|
||
[](https://discord.gg/Uq7gcHh)
|
||
[](https://docs.qmk.fm)
|
||
[](https://github.com/qmk/qmk_firmware/pulse/monthly)
|
||
[](https://github.com/qmk/qmk_firmware/)
|
||
|
||
## 什麼是QMK固件？
|
||
|
||
QMK是一個由社群維護的開源鍵盤韌體，其中包含了QMK Toolbox、qmk.fm和其它文件。QMK韌體是以[tmk\_keyboard](http://github.com/tmk/tmk_keyboard)為基礎，讓一些有用的功能在Atmel AVR控制器實現，使用於[OLKB](https://olkb.com)、[ergodox EZ](http://www.ergodox-ez.com)，和[Clueboard](http://clueboard.co/)的產品中。它也被移植到使用ChibiOS的ARM晶片上。你也可以用它來讓你徒手佈線，或是客製的鍵盤PCB發揮功能。
|
||
|
||
## 如何得到QMK
|
||
|
||
如果你打算貢獻鍵盤佈局，鍵盤或功能QMK，最容易做的事情是[叉通過Github上爬行](https://github.com/qmk/qmk_firmware#fork-destination-box)，和克隆你爬在本地進行更改，推動他們，然後打開從你的叉子[拉請求](https://github.com/qmk/qmk_firmware/pulls)。
|
||
|
||
否則，您可以直接下載([拉鍊](https://github.com/qmk/qmk_firmware/zipball/master) [焦油](https://github.com/qmk/qmk_firmware/tarball/master))，或者通過GIT中克隆它(`git@github.com:qmk/qmk_firmware.git`)或HTTP(`https://github.com/qmk/qmk_firmware.git`)。
|
||
|
||
## 如何編譯
|
||
|
||
你可以編譯之前，你需要[安裝環境](getting_started_build_tools.md)用於AVR或/和ARM開發。一旦完成，你會使用`make`命令建立一個鍵盤並用以下符號鍵盤佈局
|
||
|
||
make planck/rev4:default
|
||
|
||
這將建立`rev4` `planck`的修訂與`default`鍵盤映射。並非所有鍵盤有一個修訂版(也稱為子項目或文件夾)，在這種情況下，它可以被省略：
|
||
|
||
make preonic:default
|
||
|
||
## 如何赶近
|
||
|
||
QMK有很多[特點](features.md)探索和很好的協議[參考文獻](http://docs.qmk.fm)挖通的。大部分功能通過修改[鍵盤映射(keymap.md)，並改變[鍵碼](keycodes.md)冤大頭。
|