qmk_firmware/he-il/README.md

35 lines
3.4 KiB
Markdown
Raw Normal View History

<div dir="rtl" markdown="1">
# ืงื•ืฉื—ื” ืขื‘ื•ืจ Quantum Mechanical Keyboard
[![ื’ื™ืจืกื” ื ื•ื›ื—ื™ืช](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
[![ืžืฆื‘ ื”ื‘ื ื™ื”](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware)
[![ืขืจื•ืฅ ื“ื™ืกืงื•ืจื“](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
[![ืžืฆื‘ ืžืกืžื›ื™ื](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
[![ืชื•ืžื›ื™ GitHub](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
[![ืžื–ืœื’ื•ืช GitHub](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
## ืžื” ื”ื™ื ืงื•ืฉื—ืช QMK?
QMK (*Quantum Mechanical Keyboard*) ื”ื™ื ืงื”ื™ืœืช ืงื•ื“ ืคืชื•ื— (open source) ืฉืžืชื—ื–ืงืช ืืช ืงื•ืฉื—ืช QMK, QMK Toolbox, qmk.fm, ื•ื”ืžืกืžื›ื™ื ื”ืžืชืื™ืžื™ื. ืงื•ืฉื—ืช QMK ื”ื™ื ืงื•ืฉื—ื” ืขื‘ื•ืจ ืžืงืœื“ื•ืช ื”ืžื‘ื•ืกืกืช ืขืœ [tmk\_keyboard](http://github.com/tmk/tmk_keyboard) ืขื ื›ืžื” ืชื•ืกืคื•ืช ืขื‘ื•ืจ ื‘ืงืจื™ Atmel AVR ื•ื‘ืื•ืคืŸ ืกืคืฆื™ืคื™ ื™ื•ืชืจ - [ืžื•ืฆืจื™ OLKB](http://olkb.com), ืžืงืœื“ืช [ErgoDox EZ](http://www.ergodox-ez.com), ื•ื’ื [ืžื•ืฆืจื™ Clueboard](http://clueboard.co/). ื‘ื ื•ืกืฃ, ื”ืงื•ืฉื—ื” ืขื‘ืจื” ืคื•ืจื˜ ืขื‘ื•ืจ ืฉื‘ื‘ื™ ARM ื‘ืืžืฆืขื•ืช ChibiOS. ื ื™ืชืŸ ืœื”ืฉืชืžืฉ ื‘ื” ืขืœ ืžื ืช ืœื”ืคืขื™ืœ ืืช ืžืงืœื“ื•ืช ื” PCB ื”ืžืงื•ืกื˜ืžื•ืช ืฉืœืš.
## ืื™ืš ืœื”ืฉื™ื’ ืื•ืชื”
ืื ืืชื ืžืชื›ื ื ื™ื ืœืชืจื•ื ืžื™ืคื•ื™ ืžืงืฉื™ื, ืžืงืœื“ืช ืื• ื™ื›ื•ืœืช ืœ QMK, ื”ื“ื‘ืจ ื”ืงืœ ื‘ื™ื•ืชืจ ื”ื•ื [ืœืขืฉื•ืช ืคื•ืจืง ืœืจื™ืคื• ื‘GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box), ื•ืœืขืฉื•ืช ืงืœื•ืŸ ืœืจื™ืคื• ื‘ืกื‘ื™ื‘ื” ื”ืžืงื•ืžื™ืช ื•ืฉื ืœื‘ืฆืข ืืช ื”ืฉื™ื ื•ื™ื™ื ืฉืœื›ื, ืœื“ื—ื•ืฃ ืื•ืชื ื•ืœืคืชื•ื— [Pull Request](https://github.com/qmk/qmk_firmware/pulls) ืžื”ืคื•ืจืง ืฉืœืš.
ืื—ืจืช, ืืคืฉืจ ืœื”ื•ืจื™ื“ ืืช ื”ืงื•ืฉื—ื” ื‘ืื•ืคืŸ ื™ืฉื™ืจ ([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`).
## ืื™ืš ืœืงืžืคืœ
ืœืคื ื™ ืฉืชืฆืœื™ื—ื• ืœืงืžืคืœ, ืชื“ืจืฉื• [ืœื”ืชืงื™ืŸ ืกื‘ื™ื‘ื”](he-il/getting_started_build_tools.md) ืขื‘ื•ืจ ืคื™ืชื•ื— AVR ื•/ืื• ARM. ื‘ืจื’ืข ืฉื”ื“ื‘ืจ ื‘ื•ืฆืข, ืชื•ื›ืœื• ืœื”ืจื™ืฅ ืคืงื•ื“ืช `make` ื›ื“ื™ ืœื‘ื ื•ืช ืžืงืœื“ืช ื•ืžื™ืคื•ื™ ืขื ื”ืชื—ื‘ื™ืจ ื”ื‘ื:
make planck/rev4:default
ื›ืš ืชื•ื›ืœื• ืœื‘ื ื•ืช ืืช ื’ืจืกื `rev4` ืฉืœ ื” `planck` ืขื ืžื™ืคื•ื™ ื‘ืจื™ืจืช ื”ืžื—ื“ืœ (`default`). ืœื ื›ืœ ื”ืžืงืœื“ื•ืช ื‘ืขืœื•ืช ื’ืจืกืื•ืช (ื ืงืจื ื’ื ืชืช-ืคืจื•ื™ื™ืงื˜ ืื• ืชื™ืงื™ื™ื”), ื‘ืžืงืจื” ื›ื–ื”, ืืคืฉืจ ืœื”ืจื™ืฅ ืืช ื”ืคืงื•ื“ื” ื”ื‘ืื”:
make preonic:default
## ืื™ืš ืœื”ืชืื™ื
ืœQMK ื™ืฉ ื”ืžื•ืŸ [ื™ื›ื•ืœื•ืช](he-il/features.md) ืฉืืคืฉืจ ืœื ื•ื•ื˜ ื‘ื”ืŸ, ื•ื›ืžื•ืช ื ื›ื‘ื“ืช ืฉืœ [ืชื™ืขื•ื“ ื•ื“ื•ืงื•ืžื ื˜ืฆื™ื”](http://docs.qmk.fm) ื‘ื” ืืคืฉืจ ืœื ื‘ื•ืจ. ืจื•ื‘ ื”ืคื™ืฆืณืจื™ื ื‘ืื™ื ืœื™ื“ื™ ื‘ื™ื˜ื•ื™ ืขืœ ื™ื“ื™ ืฉื™ื ื•ื™ [ืžื™ืคื•ื™ ื”ืžืงืœื“ืช](he-il/keymap.md) ื•ืฉื™ื ื•ื™ [ืงื•ื“ื™ ื”ืžืงืฉื™ื](he-il/keycodes.md).
</div>