diff options
| author | Nikita Titov <nekit94-12@hotmail.com> | 2019-10-29 02:22:58 +0300 |
|---|---|---|
| committer | noroadsleft <18669334+noroadsleft@users.noreply.github.com> | 2019-10-28 16:22:58 -0700 |
| commit | 4fef3b23e4d9507cf5d6f26a845f5230d057827e (patch) | |
| tree | b3da7dbb766f0920370556e535307117c7e0afad | |
| parent | f19c8b2d5daedcbf833fe8320f290cad9d9f0b83 (diff) | |
| download | qmk_firmware-4fef3b23e4d9507cf5d6f26a845f5230d057827e.tar.gz qmk_firmware-4fef3b23e4d9507cf5d6f26a845f5230d057827e.zip | |
[Docs] started Russian translation of Newbs Guide (partial) (#6967)
* started Russian translation
* added translation of some newbs docs
* do not translate firmware word in name and transliterate names keeping original ones in brackets
* addressed review comments
* addressed more review comments
Co-Authored-By: nabokovas <bbkv@bk.ru>
| -rw-r--r-- | docs/_langs.md | 1 | ||||
| -rw-r--r-- | docs/ru-ru/README.md | 32 | ||||
| -rw-r--r-- | docs/ru-ru/getting_started_build_tools.md | 168 | ||||
| -rw-r--r-- | docs/ru-ru/newbs.md | 23 | ||||
| -rw-r--r-- | docs/ru-ru/newbs_getting_started.md | 102 |
5 files changed, 326 insertions, 0 deletions
diff --git a/docs/_langs.md b/docs/_langs.md index c91e0d93f..2a4caf66f 100644 --- a/docs/_langs.md +++ b/docs/_langs.md | |||
| @@ -2,3 +2,4 @@ | |||
| 2 | - [:uk: English](/) | 2 | - [:uk: English](/) |
| 3 | - [:cn: 中文](/zh-cn/) | 3 | - [:cn: 中文](/zh-cn/) |
| 4 | - [:fr: Français](/fr-fr/) | 4 | - [:fr: Français](/fr-fr/) |
| 5 | - [:ru: Русский](/ru-ru/) | ||
diff --git a/docs/ru-ru/README.md b/docs/ru-ru/README.md new file mode 100644 index 000000000..366a76036 --- /dev/null +++ b/docs/ru-ru/README.md | |||
| @@ -0,0 +1,32 @@ | |||
| 1 | # Quantum Mechanical Keyboard Firmware | ||
| 2 | |||
| 3 | [](https://github.com/qmk/qmk_firmware/tags) | ||
| 4 | [](https://travis-ci.org/qmk/qmk_firmware) | ||
| 5 | [](https://discord.gg/Uq7gcHh) | ||
| 6 | [](https://docs.qmk.fm) | ||
| 7 | [](https://github.com/qmk/qmk_firmware/pulse/monthly) | ||
| 8 | [](https://github.com/qmk/qmk_firmware/) | ||
| 9 | |||
| 10 | ## Что такое QMK Firmware? | ||
| 11 | |||
| 12 | QMK (*Quantum Mechanical Keyboard*) — это сообщество, работающее над ПО с открытым исходным кодом, которое разрабатывает QMK Firmware, QMK Toolbox, qmk.fm и эту документацию. QMK Firmware — это прошивка для клавиатур, основанная на [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. Вы можете использовать ее для клавиатуры, собранной вручную или имеющей нестандартную печатную плату. | ||
| 13 | |||
| 14 | ## Как скачать | ||
| 15 | |||
| 16 | Если вы собираетесь добавить раскладку, клавиатуру или новые функции в QMK, то самый простой путь реализации — это [сделать форк репозитория на GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box), клонировать ваш репозиторий локально для дальнейшего внесения изменений, сделать пуш изменений, а затем открыть [пулреквест](https://github.com/qmk/qmk_firmware/pulls) из вашего форка. | ||
| 17 | |||
| 18 | Также вы можете либо скачать репозиторий ([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`). | ||
| 19 | |||
| 20 | ## Как скомпилировать | ||
| 21 | |||
| 22 | Перед компиляцией вам необходимо [настроить окружение](ru-ru/getting_started_build_tools.md) разработчика для AVR или/и ARM. После этого используйте команду `make` со следующим синтаксисом, чтобы собрать клавиатуру и раскладку: | ||
| 23 | |||
| 24 | make planck/rev4:default | ||
| 25 | |||
| 26 | Данная команда соберет ревизию `rev4` клавиатуры `planck` с раскладкой `default`. Не все клавиатуры имеют ревизии (они также называются subprojects или folders), в этом случае она может быть опущена: | ||
| 27 | |||
| 28 | make preonic:default | ||
| 29 | |||
| 30 | ## Как настроить | ||
| 31 | |||
| 32 | QMK обладает множеством [функций](ru-ru/features.md) для исследования, и [справочная документация](http://docs.qmk.fm) может стать хорошей отправной точкой для знакомства с ними. Большинством функций можно воспользоваться модифицируя [раскладку](ru-ru/keymap.md) и изменяя [коды клавиш](ru-ru/keycodes.md). | ||
diff --git a/docs/ru-ru/getting_started_build_tools.md b/docs/ru-ru/getting_started_build_tools.md new file mode 100644 index 000000000..f59068533 --- /dev/null +++ b/docs/ru-ru/getting_started_build_tools.md | |||
| @@ -0,0 +1,168 @@ | |||
| 1 | # Установка инструментов для сборки | ||
| 2 | |||
| 3 | Данная страница описывает процесс установки окружения для сборки QMK. Эти инструкции относятся к процессорам AVR (таким как atmega32u4). | ||
| 4 | |||
| 5 | <!-- FIXME: Нужно написать и добавить куда-нибудь инструкции для ARM. --> | ||
| 6 | |||
| 7 | **Примечание:** Если вы здесь впервые, ознакомьтесь с [Руководством для полных новичков](ru-ru/newbs.md). | ||
| 8 | |||
| 9 | Прежде, чем продолжить, убедитесь, что у вас обновлены подмодули (сторонние библиотеки), выполнив `make git-submodule`. | ||
| 10 | |||
| 11 | ## Linux | ||
| 12 | |||
| 13 | Чтобы всегда быть уверенными, что у вас установлены последние версии ПО, можно просто выполнить команду `sudo util/qmk_install.sh`. Она должна установить все необходимые зависимости. **Это выполнит `apt-get upgrade`.** | ||
| 14 | |||
| 15 | Вы также можете устанавливать все вручную, но в данной документации список требований может не всегда быть актуальным. | ||
| 16 | |||
| 17 | Текущие требования представлены ниже, но не все они могут быть необходимы, так как зависят от того, что вы делаете. Также стоит отметить, что в некоторых системах не все зависимости доступны в виде пакетов, или они могут называться по-другому. | ||
| 18 | |||
| 19 | ``` | ||
| 20 | build-essential | ||
| 21 | gcc | ||
| 22 | unzip | ||
| 23 | wget | ||
| 24 | zip | ||
| 25 | gcc-avr | ||
| 26 | binutils-avr | ||
| 27 | avr-libc | ||
| 28 | dfu-programmer | ||
| 29 | dfu-util | ||
| 30 | gcc-arm-none-eabi | ||
| 31 | binutils-arm-none-eabi | ||
| 32 | libnewlib-arm-none-eabi | ||
| 33 | git | ||
| 34 | ``` | ||
| 35 | |||
| 36 | Установите все зависимости при помощи вашего любимого менеджера пакетов. | ||
| 37 | |||
| 38 | Пример для Debian / Ubuntu: | ||
| 39 | |||
| 40 | sudo apt-get update | ||
| 41 | sudo apt-get install gcc unzip wget zip gcc-avr binutils-avr avr-libc dfu-programmer dfu-util gcc-arm-none-eabi binutils-arm-none-eabi libnewlib-arm-none-eabi | ||
| 42 | |||
| 43 | Пример для Fedora / Red Hat: | ||
| 44 | |||
| 45 | sudo dnf install gcc unzip wget zip dfu-util dfu-programmer avr-gcc avr-libc binutils-avr32-linux-gnu arm-none-eabi-gcc-cs arm-none-eabi-binutils-cs arm-none-eabi-newlib | ||
| 46 | |||
| 47 | Пример для Arch / Manjaro: | ||
| 48 | |||
| 49 | pacman -S base-devel gcc unzip wget zip avr-gcc avr-binutils avr-libc dfu-util arm-none-eabi-gcc arm-none-eabi-binutils arm-none-eabi-newlib git dfu-programmer dfu-util | ||
| 50 | |||
| 51 | ## Nix | ||
| 52 | |||
| 53 | Если вы используете [NixOS](https://nixos.org/), или у вас установлена Nix в Linux или macOS, выполните `nix-shell` из корня репозитория, чтобы настроить окружение для сборки. | ||
| 54 | |||
| 55 | По умолчанию, это скачает компиляторы для AVR и ARM. Если вам не нужны они оба, отключите `avr` или `arm` с помощью аргумента, например: | ||
| 56 | |||
| 57 | nix-shell --arg arm false | ||
| 58 | |||
| 59 | ## macOS | ||
| 60 | |||
| 61 | Если вы пользуетесь [Homebrew](https://brew.sh/), вы можете использовать следующие команды: | ||
| 62 | |||
| 63 | brew tap osx-cross/avr | ||
| 64 | brew tap PX4/homebrew-px4 | ||
| 65 | brew update | ||
| 66 | brew install avr-gcc@8 | ||
| 67 | brew link --force avr-gcc@8 | ||
| 68 | brew install dfu-programmer | ||
| 69 | brew install dfu-util | ||
| 70 | brew install gcc-arm-none-eabi | ||
| 71 | brew install avrdude | ||
| 72 | |||
| 73 | Данный метод является рекомендуемым. Если у вас нет Homebrew, [установите его!](http://brew.sh/) Он очень сильно пригодится тем, кто работает с командной строкой. Стоит отметить, что часть с `make` и `make install` во время установки `avr-gcc@8` из Homebrew может занимать более 20 минут и сильно нагружать CPU. | ||
| 74 | |||
| 75 | ## Windows с MSYS2 (рекомендуется) | ||
| 76 | |||
| 77 | Наилучшим окружение для Windows Vista и всех последующих версий (тестировалось с 7 и 10) является [MSYS2](https://www.msys2.org). | ||
| 78 | |||
| 79 | * Для установки MSYS2, скачайте его и следуйте дальнейшим указаниям отсюда: http://www.msys2.org | ||
| 80 | * Откройте ``MSYS2 MingGW 64-bit`` ярлык | ||
| 81 | * Перейдите в свой репозиторий QMK. Например, если он находится в корне вашего диска C: | ||
| 82 | * `$ cd /c/qmk_firmware` | ||
| 83 | * Запустите `util/qmk_install.sh` и следуйте подсказкам | ||
| 84 | |||
| 85 | ## Windows 10 (устарело) | ||
| 86 | |||
| 87 | Это устаревшие инструкции для Windows 10. Мы рекомендуем использовать [MSYS2, как сказано выше](#windows-с-msys2-рекомендуется). | ||
| 88 | |||
| 89 | ### Обновление для дизайнеров (Creators Update) | ||
| 90 | |||
| 91 | Если у вас Windows 10 с Обновлением для дизайнеров или новее, вы можете собрать прошивку и прошить ей напрямую. До Обновления для дизайнеров было возможно только собрать прошивку. Если у вас его еще нет, или вы не уверены, следуйте [этим инструкциям](https://support.microsoft.com/en-us/instantanswers/d4efb316-79f0-1aa1-9ef3-dcada78f3fa0/get-the-windows-10-creators-update). | ||
| 92 | |||
| 93 | ### Подсистема Windows для Linux (Windows Subsystem for Linux, WSL) | ||
| 94 | |||
| 95 | В дополнение к Обновлению для дизайнеров вам необходима подсистема Windows для Linux, поэтому установите ее, следуя [иснтрукциям здесь](http://www.howtogeek.com/249966/how-to-install-and-use-the-linux-bash-shell-on-windows-10/). Если у вас уже есть подсистема Windows для Linux из Юбилейного обновления (Anniversary update), рекомендуется ее [обновить](https://betanews.com/2017/04/14/upgrade-windows-subsystem-for-linux/) до 16.04LTS, потому что некоторые клавиатуры не компилируются с набором инструментов из 14.04LTS. Стоит отметить, что вы четко должны понимать, что вы делаете, если выбрали метод `sudo do-release-upgrade`. | ||
| 96 | |||
| 97 | ### Git | ||
| 98 | |||
| 99 | Если вы уже клонировали репозиторий в файловую систему Windows, вы можете пропустить данную секцию. | ||
| 100 | |||
| 101 | Вам нужно клонировать репозиторий в файловую систему Windows при помощи обычного Git для Windows, а **не** WSL Git. Так что, если вы ещё не установили Git, [скачайте](https://git-scm.com/download/win) и установите его. Затем [настройте его](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup). Важно указать свой адрес электронной почты и имя пользователя, особенно если вы планируете вносить свой вклад в проект. | ||
| 102 | |||
| 103 | Как только Git будет установлен, откройте командную строку Git Bash и поменяйте директорию на ту, в которую хотите клонировать QMK; обратите внимание, что вы должны использовать косую черту, и что доступ к вашему диску C осуществляется примерно так: `/c/path/to/where/you/want/to/go`. Затем выполните `git clone --recurse-submodules https://github.com/qmk/qmk_firmware`, это создаст новую папку `qmk_firmware` в текущей директории. | ||
| 104 | |||
| 105 | ### Установка инструментов (Toolchain) | ||
| 106 | |||
| 107 | Установка инструментов (Toolchain) осуществляется через подсистему Windows для Linux, и процесс полностью автоматизирован. Если вы хотите выполнить установку вручную, то не существует никакой другой инструкции помимо самого скрипта. Однако, вы всегда можете открыть ишью и запросить дополнительную информацию. | ||
| 108 | |||
| 109 | 1. Откройте "Bash On Ubuntu On Windows" в меню Пуск. | ||
| 110 | 2. Перейдите в папку, в которую клонирована `qmk_firmware`. Обратите внимание, что пути начинаются с `/mnt/` в WSL, так что вы должны написать, например, `cd /mnt/c/path/to/qmk_firmware`. | ||
| 111 | 3. Запустите `util/wsl_install.sh` и следуйте инструкциям на экране. | ||
| 112 | 4. Закройте окно командной строки Bash, и откройте его снова. | ||
| 113 | 5. Все готово, чтобы скомпилировать прошивку и прошить ей! | ||
| 114 | |||
| 115 | ### Несколько важных вещей, которые надо запомнить | ||
| 116 | |||
| 117 | * Вы можете запустить `util/wsl_install.sh` еще раз, чтобы установить все последние обновления. | ||
| 118 | * Ваш репозиторий QMK должен находиться в файловой системе Windows, поскольку WSL не может запускать выполняемые файлы извне. | ||
| 119 | * WSL Git **не** совместим с Windows Git, поэтому используйте Windows Git Bash или Windows Git GUI для всех операций с Git. | ||
| 120 | * Вы можете изменять файлы как внутри WSL, так и просто через Windows. Но обратите внимание, что если вы изменяете makefiles или сценарии командной строки, вы должны убедиться, что используете текстовый редактор, который сохраняет файлы с переводом строки в стиле Unix (Unix line endings). В противном случае компиляция может не работать. | ||
| 121 | |||
| 122 | ## Windows (Vista и новее) (устарело) | ||
| 123 | |||
| 124 | Это устаревшие инструкции для Windows Vista и более новых версий. Мы рекомендуем использовать [MSYS2, как сказано выше](#windows-с-msys2-рекомендуется). | ||
| 125 | |||
| 126 | 1. Если вы когда-то устанавливали WinAVR, удалите его. | ||
| 127 | 2. Установите [MHV AVR Tools](https://infernoembedded.com/sites/default/files/project/MHV_AVR_Tools_20131101.exe). Отключите smatch, но **оставьте галочку напротив опции добавления инструмента в PATH**. | ||
| 128 | 3. Если вы собираетесь прошивать клавиатуры на базе Infinity, вам нужно установить dfu-util. Обратитесь к инструкциям от [Input Club](https://github.com/kiibohd/controller/wiki/Loading-DFU-Firmware). | ||
| 129 | 4. Установите [MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download). Во время установки отключите опцию установки графического пользовательского интерфейса. **НЕ ИЗМЕНЯЙТЕ директорию для установки по умолчанию.** Скрипты зависят от расположения по умолчанию. | ||
| 130 | 5. Выполните клонирование данного репозитория. [Эта ссылка скачает его в виде zip-файла, который вам нужно будет разархивировать.](https://github.com/qmk/qmk_firmware/archive/master.zip) Откройте извлеченную папку в проводнике Windows. | ||
| 131 | 6. Перейдите в папку `\util`. | ||
| 132 | 7. Запустите двойным щелчком пакетный файл сценария `1-setup-path-win`. Вам нужно будет согласиться с уведомлением контроля учетных записей пользователей (User Account Control, UAC). Нажмите пробел, чтобы закрыть появившееся сообщение об успешном выполнении операции в командной строке. | ||
| 133 | 8. Кликните правой кнопкой по пакетному файлу сценария `2-setup-environment-win`, выберите "Запуск от имени администратора" и согласитесь с уведомлением UAC. Это может занять пару минут, и вам потребуется подтвердить установку драйвера. Как только сценарий завершит свою работу, ваше окружение будет готово! | ||
| 134 | |||
| 135 | Если у вас возникли проблемы и вам нужна помощь, будет полезно сгенерировать файл *Win_Check_Output.txt*, запустив `Win_Check.bat` в папке `\util`. | ||
| 136 | |||
| 137 | ## Docker | ||
| 138 | |||
| 139 | Если это немного сложновато для вас, Docker может стать готовым решением, которое вы ищите. После установки [Docker CE](https://docs.docker.com/install/#supported-platforms) выполните следующую команду из директории `qmk_firmware`, чтобы собрать клавиатуру/раскладку: | ||
| 140 | |||
| 141 | ```bash | ||
| 142 | util/docker_build.sh keyboard:keymap | ||
| 143 | # Например: util/docker_build.sh ergodox_ez:steno | ||
| 144 | ``` | ||
| 145 | |||
| 146 | Это скомпилирует указанную клавиатуру/раскладку и создаст для вас `.hex` или `.bin` файл с результатом, готовым к процессу прошивки, в директории QMK. Если опустить `:keymap`, будет использована раскладка `default`. Заметьте, что формат параметров такой же, как и в случае сборки командой `make`. | ||
| 147 | |||
| 148 | Вы также можете запустить скрипт без параметров. Тогда он попросит вас ввести поочередно параметры сборки. Возможно, вам это покажется более удобным: | ||
| 149 | |||
| 150 | ```bash | ||
| 151 | util/docker_build.sh | ||
| 152 | # Читает параметры из пользовательского ввода (оставьте пустым для значений по умолчанию) | ||
| 153 | ``` | ||
| 154 | |||
| 155 | Также имеется поддержка сборки _и_ прошивки клавиатуры прямо из Docker. Для этого укажите еще один параметр `target`: | ||
| 156 | |||
| 157 | ```bash | ||
| 158 | util/docker_build.sh keyboard:keymap:target | ||
| 159 | # Например: util/docker_build.sh planck/rev6:default:dfu-util | ||
| 160 | ``` | ||
| 161 | |||
| 162 | Если вы используете Linux, это должно работать прямо из коробки. На Windows и macOS это требует запуска [Docker Machine](http://gw.tnode.com/docker/docker-machine-with-usb-support-on-windows-macos/). Ее довольно утомительно настраивать, поэтому мы не рекомендуем это; используйте вместо этого [QMK Toolbox](https://github.com/qmk/qmk_toolbox). | ||
| 163 | |||
| 164 | !> Docker для Windows требует включения [Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v). Это означает, что он не работает на версиях Windows без Hyper-V, например, на Windows 7, Windows 8 и **Windows 10 Home**. | ||
| 165 | |||
| 166 | ## Vagrant | ||
| 167 | |||
| 168 | Если у вас возникли проблемы при сборке прошивки, вы можете попробовать установить инструмент под названием Vagrant. Он сконфигурирует виртуальный компьютер с такими параметрами, которые подходят для сборки прошивки. У OLKB НЕТ файлов такого виртуально компьютера. Подробности о том, как настроить Vagrant, можно найти в [Руководстве по Vagrant](ru-ru/getting_started_vagrant.md). | ||
diff --git a/docs/ru-ru/newbs.md b/docs/ru-ru/newbs.md new file mode 100644 index 000000000..0e7bd6499 --- /dev/null +++ b/docs/ru-ru/newbs.md | |||
| @@ -0,0 +1,23 @@ | |||
| 1 | # Руководство по QMK для полных новичков | ||
| 2 | |||
| 3 | QMK ― это мощная прошивка с открытым исходным кодом для вашей механической клавиатуры. Вы можете использовать QMK для легкой и мощной персонализации своей клавиатуры. Люди с разным уровнем умений, от совсем новичков до крутых программистов, успешно применяли QMK, чтобы персонализировать свои клавиатуры. Данное руководство поможет вам сделать то же самое, независимо от уровня вашего мастерства. | ||
| 4 | |||
| 5 | Не уверены, поддерживает ли ваша клавиатура QMK? Если это механическая клавиатура, которую вы собрали сами, шансы достаточно велики. Мы поддерживаем [большое число любительских клавиатур](https://qmk.fm/keyboards/), поэтому, даже если ваша текущая клавиатура не совместима с QMK, у вас не должно возникнуть проблем с нахождением подходящей для ваших нужд. | ||
| 6 | |||
| 7 | ## Обзор | ||
| 8 | |||
| 9 | В данном руководстве 7 основных секций: | ||
| 10 | |||
| 11 | * [Первое знакомство](ru-ru/newbs_getting_started.md) | ||
| 12 | * [Собираем вашу первую прошивку с помощью командной строки](ru-ru/newbs_building_firmware.md) | ||
| 13 | * [Собираем вашу первую прошивку с помощью онлайн GUI](ru-ru/newbs_building_firmware_configurator.md) | ||
| 14 | * [Прошиваем файл прошивки](ru-ru/newbs_flashing.md) | ||
| 15 | * [Тестируем и отлаживаем](ru-ru/newbs_testing_debugging.md) | ||
| 16 | * [Лучшие практики по Git](ru-ru/newbs_best_practices.md) | ||
| 17 | * [Узнайте больше на этих ресурсах](ru-ru/newbs_learn_more_resources.md) | ||
| 18 | |||
| 19 | Данное руководство сосредоточено на помощи тем, кто никогда раньше не компилировал ПО. Приятие решений и рекомендации делаются с учетом именно этого. Существует много альтернативных методов для описанных процедур, и мы поддерживаем большинство из них. Если у вас есть сомнения о том, как выполнить задачу, вы можете [попросить у нас совета](ru-ru/getting_started_getting_help.md). | ||
| 20 | |||
| 21 | ## Дополнительные ресурсы | ||
| 22 | |||
| 23 | * [Блог Томаса Баарта (Thomas Baart) об основах QMK](https://thomasbaart.nl/category/mechanical-keyboards/firmware/qmk/qmk-basics/) – Созданный пользователем блог, охватывающий основы использования QMK Firmware с точки зрения нового пользователя. | ||
diff --git a/docs/ru-ru/newbs_getting_started.md b/docs/ru-ru/newbs_getting_started.md new file mode 100644 index 000000000..a301e9adb --- /dev/null +++ b/docs/ru-ru/newbs_getting_started.md | |||
| @@ -0,0 +1,102 @@ | |||
| 1 | # Введение | ||
| 2 | |||
| 3 | У вашей компьютерной клавиатуры внутри есть процессор, похожий на тот, что внутри вашего компьютера. Этот процессор выполняет программное обеспечение, которое отвечает за обнаружение нажатий клавиш и отсылку сигналов состояния клавиатуры, когда клавиши нажимаются и отпускаются. Роль такого ПО выполняет QMK, детектируя нажатия клавиш и отсылая эту информацию главному компьютеру. Сбор собственной раскладки эквивалентен сборке выполняемой программы для вашей клавиатуры. | ||
| 4 | |||
| 5 | QMK старается дать вам большую силу, оставляя простые вещи легкими и делай сложные — возможными. Вам не надо уметь программировать, чтобы создавать мощные прошивки — вам только надо следовать нескольким простым синтаксическим правилам. | ||
| 6 | |||
| 7 | # Первое знакомство | ||
| 8 | |||
| 9 | Перед тем, как вы сможете собирать раскладки, вам необходимо установить некоторое программное обеспечение и настроить ваше окружение для сборки. Это нужно сделать только один раз, вне зависимости от того, для скольких клавиатур вы планируете компилировать прошивки. | ||
| 10 | |||
| 11 | Если вы предпочитаете графический пользовательский интерфейс, пожалуйста, рассмотрите возможность использования онлайн [QMK Конфигуратора](https://config.qmk.fm). Пожалуйста, обратитесь к [Собираем вашу первую прошивку с помощью онлайн GUI](ru-ru/newbs_building_firmware_configurator.md). | ||
| 12 | |||
| 13 | |||
| 14 | ## Загрузка ПО | ||
| 15 | |||
| 16 | ### Текстовый редактор | ||
| 17 | |||
| 18 | Вам понадобится программа, умеющая редактировать и сохранять **обычные текстовые** файлы. Если вы используете Windows, вы можете делать это Блокнотом, а в Linux вы можете использовать gedit. Обе программы являются простыми, но функциональными редакторами. В macOS остерегайтесь стандартного приложения TextEdit: он не будет сохранять обычные текстовые файлы, пока вы явно не выберите _Make Plain Text_ из меню _Format_. | ||
| 19 | |||
| 20 | Вы также можете скачать и установить отдельный текстовый редактор наподобие [Sublime Text](https://www.sublimetext.com/) или [VS Code](https://code.visualstudio.com/). Возможно, это наилучший вариант независимо от платформы, поскольку эти программы сделаны специально для редактирования кода. | ||
| 21 | |||
| 22 | ?> Не уверены, какой выбрать текстовый редактор? Лоуренс Брэдфорд (Laurence Bradford) написал [отличное введение](https://learntocodewith.me/programming/basics/text-editors/) в тему. | ||
| 23 | |||
| 24 | ### QMK Toolbox | ||
| 25 | |||
| 26 | QMK Toolbox является дополнительной графической программой для Windows и macOS, которая позволяет вам разрабатывать и отлаживать вашу клавиатуру. Вы, вероятно, посчитаете ее бесценной для легкого процесса прошивки вашей клавиатуры и просмотра отладочных сообщений, которые она отображает. | ||
| 27 | |||
| 28 | [Скачайте последний выпуск здесь.](https://github.com/qmk/qmk_toolbox/releases/latest) | ||
| 29 | |||
| 30 | * Для Windows: `qmk_toolbox.exe` (переносимое приложение) или `qmk_toolbox_install.exe` (установщик) | ||
| 31 | * Для macOS: `QMK.Toolbox.app.zip` (переносимое приложение) или `QMK.Toolbox.pkg` (установщик) | ||
| 32 | |||
| 33 | ## Настройте ваше окружение | ||
| 34 | |||
| 35 | Мы постарались сделать установку QMK максимально легкой. Вам нужно только подготовить ваше Linux или Unix окружение, после этого позвольте QMK установить все остальное. | ||
| 36 | |||
| 37 | ?> Если вы никогда раньше не работали с командной строкой Linux/Unix, существует несколько базовых концептов и команд, которые необходимо выучить. Эти ресурсы дадут вам достаточно знаний, чтобы работать с QMK:<br> | ||
| 38 | [Обязательные к изучению команды Linux](https://www.guru99.com/must-know-linux-commands.html)<br> | ||
| 39 | [Несколько базовых команд Unix](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html) | ||
| 40 | |||
| 41 | ### Windows | ||
| 42 | |||
| 43 | Вам нужно будет установить MSYS2 и Git. | ||
| 44 | |||
| 45 | * Следуйте инструкциям по установки на [домашней странице MSYS2](https://www.msys2.org). | ||
| 46 | * Закройте все открытые терминалы MSYS2 и откройте новый терминал MSYS2 MinGW 64-bit. | ||
| 47 | * Установите Git, выполнив эту команду: `pacman -S git`. | ||
| 48 | |||
| 49 | ### macOS | ||
| 50 | |||
| 51 | Вам нужно будет установить Homebrew. Следуйте инструкциям на [домашней странице Homebrew](https://brew.sh). | ||
| 52 | |||
| 53 | После установки Homebrew продолжите чтение с _Установите QMK_. На этом шаге вам надо будет запустить скрипт, который установит остальные пакеты. | ||
| 54 | |||
| 55 | ### Linux | ||
| 56 | |||
| 57 | Вам нужно будет установить Git. Скорее всего, он у вас уже есть, но если нет, одна из следующих команд должна установить его: | ||
| 58 | |||
| 59 | * Debian / Ubuntu / Devuan: `apt-get install git` | ||
| 60 | * Fedora / Red Hat / CentOS: `yum install git` | ||
| 61 | * Arch: `pacman -S git` | ||
| 62 | |||
| 63 | ?> Docker также является вариантом для всех платформ. [Нажмите сюда для получения подробностей.](ru-ru/getting_started_build_tools.md#docker) | ||
| 64 | |||
| 65 | ## Установите QMK | ||
| 66 | |||
| 67 | Как только вы настроили ваше Linux/Unix окружение, вы готовы к загрузке QMK. Мы сделаем это при помощи Git, "клонировав" репозиторий QMK. Откройте Терминал или окно MSYS2 MinGW и оставьте его открытым до конца данного руководства. Выполните эти команды внутри него: | ||
| 68 | |||
| 69 | ```shell | ||
| 70 | git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git | ||
| 71 | cd qmk_firmware | ||
| 72 | ``` | ||
| 73 | |||
| 74 | ?> Если вы уже знаете, [как пользоваться GitHub](ru-ru/getting_started_github.md), мы рекомендуем вам вместо этого создать и клонировать свой собственный форк. Если вы не понимаете, что это значит, просто проигнорируйте это сообщение. | ||
| 75 | |||
| 76 | QMK включает в себя скрипт, который поможет вам установить все оставшееся, что вам понадобится. Вы должны запустить его, набрав эту команду: | ||
| 77 | |||
| 78 | util/qmk_install.sh | ||
| 79 | |||
| 80 | ## Протестируйте ваше окружение для сборки | ||
| 81 | |||
| 82 | Теперь, когда ваше окружение QMK для сборки настроено, вы можете собрать прошивку для вашей клавиатуры. Начните с попытки собрать раскладку для клавиатуры по умолчанию. У вас должно это получиться с помощью команды в этом формате: | ||
| 83 | |||
| 84 | make <keyboard>:default | ||
| 85 | |||
| 86 | Например, чтобы собрать прошивку для Clueboard 66%, вы введете: | ||
| 87 | |||
| 88 | make clueboard/66/rev3:default | ||
| 89 | |||
| 90 | Когда все закончится, вы должны увидеть большой лог, который заканчивается примерно так: | ||
| 91 | |||
| 92 | ``` | ||
| 93 | Linking: .build/clueboard_66_rev3_default.elf [OK] | ||
| 94 | Creating load file for flashing: .build/clueboard_66_rev3_default.hex [OK] | ||
| 95 | Copying clueboard_66_rev3_default.hex to qmk_firmware folder [OK] | ||
| 96 | Checking file size of clueboard_66_rev3_default.hex [OK] | ||
| 97 | * The firmware size is fine - 26356/28672 (2316 bytes free) | ||
| 98 | ``` | ||
| 99 | |||
| 100 | # Создаем вашу раскладку | ||
| 101 | |||
| 102 | Теперь вы готовы создать свою персональную раскладку! Для этого перейдите к [Собираем вашу первую прошивку](ru-ru/newbs_building_firmware.md). | ||
