You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

33 lines
3.0 KiB

  1. # Quantum Mechanical Keyboard Firmware
  2. [![Current Version](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
  3. [![Build Status](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware)
  4. [![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
  5. [![Docs Status](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
  6. [![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
  7. [![GitHub forks](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
  8. ## QMK Firmware ๋ž€?
  9. QMK(*Quantum Mechanical Keyboard ์–‘์ž ๊ธฐ๊ณ„์‹ ํ‚ค๋ณด๋“œ*)๋ž€ QMK ์ปด์›Œ์–ด, QMK ํˆด๋ฐ•์Šค, qmk.fm ๋ฅผ ๊ด€๋ฆฌํ•˜๊ณ  ์žˆ๋Š” ์˜คํ”ˆ์†Œ์Šค ์ปค๋ฎค๋‹ˆํ‹ฐ ์ž…๋‹ˆ๋‹ค. QMKํŽŒ์›จ์–ด๋Š” [tmk\_keyboard](https://github.com/tmk/tmk_keyboard)๋ฅผ ๋ฐ”ํƒ•์œผ๋กœ ๋งŒ๋“ค์–ด์ง„ ํ‚ค๋ณด๋“œํŽŒ์›จ์–ด์ด๋ฉฐ, Atmel AVR์ปจํŠธ๋กค๋Ÿฌ์™€ [OLKB ์ œํ’ˆ๊ตฐ](https://olkb.com) [ErgoDox EZ](https://www.ergodox-ez.com), ๊ทธ๋ฆฌ๊ณ  [Clueboard ์ œํ’ˆ๊ตฐ](https://clueboard.co/) ์ด์šฉํ• ๋•Œ ๋งค์šฐ ํŽธ๋ฆฌํ•ฉ๋‹ˆ๋‹ค. ๋˜ํ•œ QMK๋Š” ChibiOS๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ARM๊ธฐ๋ฐ˜์˜ ์ปจํŠธ๋กค๋Ÿฌ๋กœ๋„ ์‚ฌ์šฉํ• ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋งˆ์ง€๋ง‰์œผ๋กœ QMK๋Š” ์ปค์Šคํ…€ํšŒ๋กœ์™€ ํ•ธ๋“œ์™€์ด์–ด๋“œ ํ‚ค๋ณด๋“œ์„ ์ž‘๋™์‹œํ‚ค๋Š”๋ฐ์—๋„ ์‚ฌ์šฉ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.
  10. ## ์„ค์น˜ํ•˜๊ธฐ
  11. ๋งŒ์•ฝ ๋‹น์‹ ์ด QMK์— ํ‚ค๋ณด๋“œ, ํ‚ค๋งต, ๋˜๋Š” ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€ํ•˜๊ณ ์‹ถ๋‹ค๋ฉด, ๊ฐ€์žฅ์‰ฌ์šด ๋ฐฉ๋ฒ•์€ Github๋ฅผ ํ†ตํ•ด [์ €์žฅ์†Œ(REPO)๋ฅผ ์ถ”๊ฐ€ํ•˜๊ณ ]((https://github.com/qmk/qmk_firmware#fork-destination-box)) ๋กœ์ปฌ์—์„œ ๋ณ€ํ™” ๋˜๋Š” ์ˆ˜์ •ํ•˜๊ณ , [PULL REQUEST](https://github.com/qmk/qmk_firmware/pulls)์„ ํ†ตํ•ด ์—…๋กœ๋“œ ํ• ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  12. ๋˜๋‹ค๋ฅธ ๋ฐฉ๋ฒ•์œผ๋กœ๋Š”, ์ง์ ‘ ํŒŒ์ผ๋“ค ๋กœ์ปฌ๋กœ ๋‹ค์šด๋กœ๋“œ ํ•˜๊ฑฐ๋‚˜([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`)์„ ํ†ตํ•ด ํด๋ก ์„ ๋งŒ๋“ค์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  13. ## ์ปดํŒŒ์ผ
  14. ๋จผ์ € ์ปดํŒŒ์ผ์„ ํ•˜๊ธฐ์ „ AVR ์ด๋‚˜ ARM [๊ฐœ๋ฐœํ™˜๊ฒฝ](getting_started_build_tools.md)์„ ๊ตฌ์ถ•ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋ชจ๋“ ์ค€๋น„๊ฐ€ ๋๋‚ฌ๋‹ค๋ฉด `make`๋ฅผ ๋‹ค์Œ๊ณผ ๊ฐ™์ด ํ‚ค๋ณด๋“œ์™€ ํ‚ค๋งต์„ ์„ ํƒํ•˜์—ฌ ์ปดํŒŒ์ผ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  15. make planck/rev4:default
  16. ์ด ์ปค๋งจ๋“œ๋Š” `rev4`๋ฒ„์ „์˜ `planck`๋ฅผ `default`ํ‚ค๋งต์œผ๋กœ ์ปดํŒŒ์ผ ํ• ๊ฒƒ์ž…๋‹ˆ๋‹ค. ๋‹ค๋งŒ ๋ชจ๋“  ํ‚ค๋ณด๋“œ๋Š” ํŒŒ์ผ, ์ˆ˜์ •๋ณธ ๋˜๋Š” ์„ธ๋ถ€ํ”„๋กœ์ ํŠธ๋ฅผ ๊ฐ€์ง€๊ณ ์žˆ์ง€ ์•Š์Œ์œผ๋กœ ์ˆ˜์ •๋ณธ ๋ถ€๋ถ„์„ ์ƒ๋žต๋ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  17. make preonic:default
  18. ## ์ปค์Šคํ„ฐ๋งˆ์ด์ง•
  19. QMK๋Š” ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋Š” ๋งค์šฐ ๋‹ค์–‘ํ•œ [๊ธฐ๋Šฅ](features.md)๊ณผ ์ฒด๊ณ„ํ™”๋œ [์ฐธ๊ณ ์ž๋ฃŒ](https://docs.qmk.fm)๋“ค์ด ์žˆ์Šต๋‹ˆ๋‹ค. ๊ทธ์ค‘ ๋Œ€๋ถ€๋ถ„์€ [ํ‚ค๋งต](keymap.md)์„ ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ [ํ‚ค์ฝ”๋“œ](keycodes.md)๋ฅผ ๋ณ€๊ฒฝํ•˜๋Š”๋ฐ์— ํŠนํ™”๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค.