diff options
Diffstat (limited to 'docs/ru-ru')
| -rw-r--r-- | docs/ru-ru/README.md | 31 | ||||
| -rw-r--r-- | docs/ru-ru/_summary.md | 124 | ||||
| -rw-r--r-- | docs/ru-ru/getting_started_build_tools.md | 153 | ||||
| -rw-r--r-- | docs/ru-ru/getting_started_getting_help.md | 15 | ||||
| -rw-r--r-- | docs/ru-ru/getting_started_github.md | 63 | ||||
| -rw-r--r-- | docs/ru-ru/getting_started_introduction.md | 58 | ||||
| -rw-r--r-- | docs/ru-ru/newbs.md | 23 | ||||
| -rw-r--r-- | docs/ru-ru/newbs_getting_started.md | 102 |
8 files changed, 0 insertions, 569 deletions
diff --git a/docs/ru-ru/README.md b/docs/ru-ru/README.md deleted file mode 100644 index 7218781540..0000000000 --- a/docs/ru-ru/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# Quantum Mechanical Keyboard Firmware - -[](https://github.com/qmk/qmk_firmware/tags) -[](https://discord.gg/Uq7gcHh) -[](https://docs.qmk.fm) -[](https://github.com/qmk/qmk_firmware/pulse/monthly) -[](https://github.com/qmk/qmk_firmware/) - -## Что такое QMK Firmware? - -QMK (*Quantum Mechanical Keyboard*) — это сообщество, работающее над ПО с открытым исходным кодом, которое разрабатывает QMK Firmware, QMK Toolbox, qmk.fm и эту документацию. QMK Firmware — это прошивка для клавиатур, основанная на [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/). Она также была портирована на чипы ARM при помощи ChibiOS. Вы можете использовать ее для клавиатуры, собранной вручную или имеющей нестандартную печатную плату. - -## Как скачать - -Если вы собираетесь добавить раскладку, клавиатуру или новые функции в QMK, то самый простой путь реализации — это [сделать форк репозитория на GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box), клонировать ваш репозиторий локально для дальнейшего внесения изменений, сделать пуш изменений, а затем открыть [пулреквест](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`). - -## Как скомпилировать - -Перед компиляцией вам необходимо [настроить окружение](ru-ru/getting_started_build_tools.md) разработчика для AVR или/и ARM. После этого используйте команду `make` со следующим синтаксисом, чтобы собрать клавиатуру и раскладку: - - make planck/rev4:default - -Данная команда соберет ревизию `rev4` клавиатуры `planck` с раскладкой `default`. Не все клавиатуры имеют ревизии (они также называются subprojects или folders), в этом случае она может быть опущена: - - make preonic:default - -## Как настроить - -QMK обладает множеством [функций](ru-ru/features.md) для исследования, и [справочная документация](https://docs.qmk.fm) может стать хорошей отправной точкой для знакомства с ними. Большинством функций можно воспользоваться модифицируя [раскладку](ru-ru/keymap.md) и изменяя [коды клавиш](ru-ru/keycodes.md). diff --git a/docs/ru-ru/_summary.md b/docs/ru-ru/_summary.md deleted file mode 100644 index 09273172b6..0000000000 --- a/docs/ru-ru/_summary.md +++ /dev/null @@ -1,124 +0,0 @@ -* [Complete Newbs Guide](ru-ru/newbs.md) - * [Getting Started](ru-ru/newbs_getting_started.md) - * [Building Your First Firmware](ru-ru/newbs_building_firmware.md) - * [Flashing Firmware](ru-ru/newbs_flashing.md) - * [Testing and Debugging](ru-ru/newbs_testing_debugging.md) - * [Git Best Practices](ru-ru/newbs_best_practices.md) - * [Learning Resources](ru-ru/newbs_learn_more_resources.md) - -* [QMK Basics](ru-ru/README.md) - * [QMK Introduction](ru-ru/getting_started_introduction.md) - * [QMK CLI](ru-ru/cli.md) - * [QMK CLI Config](ru-ru/cli_configuration.md) - * [Contributing to QMK](ru-ru/contributing.md) - * [How to Use GitHub](ru-ru/getting_started_github.md) - * [Getting Help](ru-ru/getting_started_getting_help.md) - -* [Breaking Changes](ru-ru/breaking_changes.md) - * [2019 Aug 30](ru-ru/ChangeLog/20190830.md) - -* [FAQ](ru-ru/faq.md) - * [General FAQ](ru-ru/faq_general.md) - * [Build/Compile QMK](ru-ru/faq_build.md) - * [Debugging/Troubleshooting QMK](ru-ru/faq_debug.md) - * [Keymap](ru-ru/faq_keymap.md) - * [Driver Installation with Zadig](ru-ru/driver_installation_zadig.md) - -* Detailed Guides - * [Install Build Tools](ru-ru/getting_started_build_tools.md) - * [Vagrant Guide](ru-ru/getting_started_vagrant.md) - * [Build/Compile Instructions](ru-ru/getting_started_make_guide.md) - * [Flashing Firmware](ru-ru/flashing.md) - * [Customizing Functionality](ru-ru/custom_quantum_functions.md) - * [Keymap Overview](ru-ru/keymap.md) - -* [Hardware](ru-ru/hardware.md) - * [Compatible Microcontrollers](ru-ru/compatible_microcontrollers.md) - * [AVR Processors](ru-ru/hardware_avr.md) - * [Drivers](ru-ru/hardware_drivers.md) - -* Reference - * [Keyboard Guidelines](ru-ru/hardware_keyboard_guidelines.md) - * [Config Options](ru-ru/config_options.md) - * [Keycodes](ru-ru/keycodes.md) - * [Coding Conventions - C](ru-ru/coding_conventions_c.md) - * [Coding Conventions - Python](ru-ru/coding_conventions_python.md) - * [Documentation Best Practices](ru-ru/documentation_best_practices.md) - * [Documentation Templates](ru-ru/documentation_templates.md) - * [Glossary](ru-ru/reference_glossary.md) - * [Unit Testing](ru-ru/unit_testing.md) - * [Useful Functions](ru-ru/ref_functions.md) - * [Configurator Support](ru-ru/reference_configurator_support.md) - * [info.json Format](ru-ru/reference_info_json.md) - * [Python CLI Development](ru-ru/cli_development.md) - -* [Features](ru-ru/features.md) - * [Basic Keycodes](ru-ru/keycodes_basic.md) - * [US ANSI Shifted Keys](ru-ru/keycodes_us_ansi_shifted.md) - * [Quantum Keycodes](ru-ru/quantum_keycodes.md) - * [Advanced Keycodes](ru-ru/feature_advanced_keycodes.md) - * [Audio](ru-ru/feature_audio.md) - * [Auto Shift](ru-ru/feature_auto_shift.md) - * [Backlight](ru-ru/feature_backlight.md) - * [Bluetooth](ru-ru/feature_bluetooth.md) - * [Bootmagic](ru-ru/feature_bootmagic.md) - * [Combos](ru-ru/feature_combo.md) - * [Command](ru-ru/feature_command.md) - * [Debounce API](ru-ru/feature_debounce_type.md) - * [DIP Switch](ru-ru/feature_dip_switch.md) - * [Dynamic Macros](ru-ru/feature_dynamic_macros.md) - * [Encoders](ru-ru/feature_encoders.md) - * [Grave Escape](ru-ru/feature_grave_esc.md) - * [Haptic Feedback](ru-ru/feature_haptic_feedback.md) - * [HD44780 LCD Controller](ru-ru/feature_hd44780.md) - * [Key Lock](ru-ru/feature_key_lock.md) - * [Layouts](ru-ru/feature_layouts.md) - * [Leader Key](ru-ru/feature_leader_key.md) - * [LED Matrix](ru-ru/feature_led_matrix.md) - * [Macros](ru-ru/feature_macros.md) - * [Mouse Keys](ru-ru/feature_mouse_keys.md) - * [OLED Driver](ru-ru/feature_oled_driver.md) - * [One Shot Keys](ru-ru/one_shot_keys.md) - * [Pointing Device](ru-ru/feature_pointing_device.md) - * [PS/2 Mouse](ru-ru/feature_ps2_mouse.md) - * [RGB Lighting](ru-ru/feature_rgblight.md) - * [RGB Matrix](ru-ru/feature_rgb_matrix.md) - * [Space Cadet](ru-ru/feature_space_cadet.md) - * [Split Keyboard](ru-ru/feature_split_keyboard.md) - * [Stenography](ru-ru/feature_stenography.md) - * [Swap Hands](ru-ru/feature_swap_hands.md) - * [Tap Dance](ru-ru/feature_tap_dance.md) - * [Terminal](ru-ru/feature_terminal.md) - * [Thermal Printer](ru-ru/feature_thermal_printer.md) - * [Unicode](ru-ru/feature_unicode.md) - * [Userspace](ru-ru/feature_userspace.md) - * [Velocikey](ru-ru/feature_velocikey.md) - -* For Makers and Modders - * [Hand Wiring Guide](ru-ru/hand_wire.md) - * [ISP Flashing Guide](ru-ru/isp_flashing_guide.md) - * [ARM Debugging Guide](ru-ru/arm_debugging.md) - * [I2C Driver](ru-ru/i2c_driver.md) - * [SPI Driver](ru-ru/spi_driver.md) - * [WS2812 Driver](ru-ru/ws2812_driver.md) - * [GPIO Controls](ru-ru/internals_gpio_control.md) - * [Proton C Conversion](ru-ru/proton_c_conversion.md) - -* For a Deeper Understanding - * [How Keyboards Work](ru-ru/how_keyboards_work.md) - * [Understanding QMK](ru-ru/understanding_qmk.md) - -* Other Topics - * [Using Eclipse with QMK](ru-ru/other_eclipse.md) - * [Using VSCode with QMK](ru-ru/other_vscode.md) - * [Support](ru-ru/getting_started_getting_help.md) - * [Translating the QMK Docs](ru-ru/translating.md) - -* QMK Internals (In Progress) - * [Defines](ru-ru/internals_defines.md) - * [Input Callback Reg](ru-ru/internals_input_callback_reg.md) - * [Midi Device](ru-ru/internals_midi_device.md) - * [Midi Device Setup Process](ru-ru/internals_midi_device_setup_process.md) - * [Midi Util](ru-ru/internals_midi_util.md) - * [Send Functions](ru-ru/internals_send_functions.md) - * [Sysex Tools](ru-ru/internals_sysex_tools.md) diff --git a/docs/ru-ru/getting_started_build_tools.md b/docs/ru-ru/getting_started_build_tools.md deleted file mode 100644 index 322f9a9e59..0000000000 --- a/docs/ru-ru/getting_started_build_tools.md +++ /dev/null @@ -1,153 +0,0 @@ -# Установка инструментов для сборки - -Данная страница описывает процесс установки окружения для сборки QMK. Эти инструкции относятся к процессорам AVR (таким как atmega32u4). - -<!-- FIXME: Нужно написать и добавить куда-нибудь инструкции для ARM. --> - -**Примечание:** Если вы здесь впервые, ознакомьтесь с [Руководством для полных новичков](ru-ru/newbs.md). - -Прежде, чем продолжить, убедитесь, что у вас обновлены подмодули (сторонние библиотеки), выполнив `make git-submodule`. - -## Linux - -Чтобы всегда быть уверенными, что у вас установлены последние версии ПО, можно просто выполнить команду `sudo util/qmk_install.sh`. Она должна установить все необходимые зависимости. **Это выполнит `apt-get upgrade`.** - -Вы также можете устанавливать все вручную, но в данной документации список требований может не всегда быть актуальным. - -Текущие требования представлены ниже, но не все они могут быть необходимы, так как зависят от того, что вы делаете. Также стоит отметить, что в некоторых системах не все зависимости доступны в виде пакетов, или они могут называться по-другому. - -``` -build-essential -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 -git -``` - -Установите все зависимости при помощи вашего любимого менеджера пакетов. - -Пример для Debian / Ubuntu: - - sudo apt-get update - 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 - -Пример для Fedora / Red Hat: - - 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 - -Пример для Arch / Manjaro: - - 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 - -## Nix - -Если вы используете [NixOS](https://nixos.org/), или у вас установлена Nix в Linux или macOS, выполните `nix-shell` из корня репозитория, чтобы настроить окружение для сборки. - -По умолчанию, это скачает компиляторы для AVR и ARM. Если вам не нужны они оба, отключите `avr` или `arm` с помощью аргумента, например: - - nix-shell --arg arm false - -## macOS - -Если вы пользуетесь [Homebrew](https://brew.sh/), вы можете использовать следующие команды: - - brew tap osx-cross/avr - brew tap PX4/homebrew-px4 - brew update - brew install avr-gcc@8 - brew link --force avr-gcc@8 - brew install dfu-programmer - brew install dfu-util - brew install gcc-arm-none-eabi - brew install avrdude - -Данный метод является рекомендуемым. Если у вас нет Homebrew, [установите его!](https://brew.sh/) Он очень сильно пригодится тем, кто работает с командной строкой. Стоит отметить, что часть с `make` и `make install` во время установки `avr-gcc@8` из Homebrew может занимать более 20 минут и сильно нагружать CPU. - -## Windows с MSYS2 (рекомендуется) - -Наилучшим окружение для Windows Vista и всех последующих версий (тестировалось с 7 и 10) является [MSYS2](https://www.msys2.org). - -* Для установки MSYS2, скачайте его и следуйте дальнейшим указаниям отсюда: https://www.msys2.org -* Откройте ``MSYS2 MingGW 64-bit`` ярлык -* Перейдите в свой репозиторий QMK. Например, если он находится в корне вашего диска C: - * `$ cd /c/qmk_firmware` -* Запустите `util/qmk_install.sh` и следуйте подсказкам - -## Windows 10 (устарело) - -Это устаревшие инструкции для Windows 10. Мы рекомендуем использовать [MSYS2, как сказано выше](#windows-с-msys2-рекомендуется). - -### Обновление для дизайнеров (Creators Update) - -Если у вас Windows 10 с Обновлением для дизайнеров или новее, вы можете собрать прошивку и прошить ей напрямую. До Обновления для дизайнеров было возможно только собрать прошивку. Если у вас его еще нет, или вы не уверены, следуйте [этим инструкциям](https://support.microsoft.com/en-us/instantanswers/d4efb316-79f0-1aa1-9ef3-dcada78f3fa0/get-the-windows-10-creators-update). - -### Подсистема Windows для Linux (Windows Subsystem for Linux, WSL) - -В дополнение к Обновлению для дизайнеров вам необходима подсистема Windows для Linux, поэтому установите ее, следуя [иснтрукциям здесь](https://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`. - -### Git - -Если вы уже клонировали репозиторий в файловую систему Windows, вы можете пропустить данную секцию. - -Вам нужно клонировать репозиторий в файловую систему 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). Важно указать свой адрес электронной почты и имя пользователя, особенно если вы планируете вносить свой вклад в проект. - -Как только 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` в текущей директории. - -### Установка инструментов (Toolchain) - -Установка инструментов (Toolchain) осуществляется через подсистему Windows для Linux, и процесс полностью автоматизирован. Если вы хотите выполнить установку вручную, то не существует никакой другой инструкции помимо самого скрипта. Однако, вы всегда можете открыть ишью и запросить дополнительную информацию. - -1. Откройте "Bash On Ubuntu On Windows" в меню Пуск. -2. Перейдите в папку, в которую клонирована `qmk_firmware`. Обратите внимание, что пути начинаются с `/mnt/` в WSL, так что вы должны написать, например, `cd /mnt/c/path/to/qmk_firmware`. -3. Запустите `util/wsl_install.sh` и следуйте инструкциям на экране. -4. Закройте окно командной строки Bash, и откройте его снова. -5. Все готово, чтобы скомпилировать прошивку и прошить ей! - -### Несколько важных вещей, которые надо запомнить - -* Вы можете запустить `util/wsl_install.sh` еще раз, чтобы установить все последние обновления. -* Ваш репозиторий QMK должен находиться в файловой системе Windows, поскольку WSL не может запускать выполняемые файлы извне. -* WSL Git **не** совместим с Windows Git, поэтому используйте Windows Git Bash или Windows Git GUI для всех операций с Git. -* Вы можете изменять файлы как внутри WSL, так и просто через Windows. Но обратите внимание, что если вы изменяете makefiles или сценарии командной строки, вы должны убедиться, что используете текстовый редактор, который сохраняет файлы с переводом строки в стиле Unix (Unix line endings). В противном случае компиляция может не работать. - -## Docker - -Если это немного сложновато для вас, Docker может стать готовым решением, которое вы ищите. После установки [Docker CE](https://docs.docker.com/install/#supported-platforms) выполните следующую команду из директории `qmk_firmware`, чтобы собрать клавиатуру/раскладку: - -```bash -util/docker_build.sh keyboard:keymap -# Например: util/docker_build.sh ergodox_ez:steno -``` - -Это скомпилирует указанную клавиатуру/раскладку и создаст для вас `.hex` или `.bin` файл с результатом, готовым к процессу прошивки, в директории QMK. Если опустить `:keymap`, будет использована раскладка `default`. Заметьте, что формат параметров такой же, как и в случае сборки командой `make`. - -Вы также можете запустить скрипт без параметров. Тогда он попросит вас ввести поочередно параметры сборки. Возможно, вам это покажется более удобным: - -```bash -util/docker_build.sh -# Читает параметры из пользовательского ввода (оставьте пустым для значений по умолчанию) -``` - -Также имеется поддержка сборки _и_ прошивки клавиатуры прямо из Docker. Для этого укажите еще один параметр `target`: - -```bash -util/docker_build.sh keyboard:keymap:target -# Например: util/docker_build.sh planck/rev6:default:dfu-util -``` - -Если вы используете 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). - -!> 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**. - -## Vagrant - -Если у вас возникли проблемы при сборке прошивки, вы можете попробовать установить инструмент под названием Vagrant. Он сконфигурирует виртуальный компьютер с такими параметрами, которые подходят для сборки прошивки. У OLKB НЕТ файлов такого виртуально компьютера. Подробности о том, как настроить Vagrant, можно найти в [Руководстве по Vagrant](ru-ru/getting_started_vagrant.md). diff --git a/docs/ru-ru/getting_started_getting_help.md b/docs/ru-ru/getting_started_getting_help.md deleted file mode 100644 index 75be44310e..0000000000 --- a/docs/ru-ru/getting_started_getting_help.md +++ /dev/null @@ -1,15 +0,0 @@ -# Получение помощи - -Существует много ресурсов для получения помощи по работе с QMK. - -## Чат в реальном времени - -Вы можете найти разработчиков и пользователей QMK на нашем главном [сервере Discord](https://discord.gg/Uq7gcHh). На сервере есть специальные каналы для разговоров о прошивке, Toolbox, оборудовании и конфигураторе. - -## OLKB Сабреддит - -Официальный форум QMK [/r/olkb](https://reddit.com/r/olkb) на [reddit.com](https://reddit.com). - -## GitHub ишью - -Вы можете открыть [ишью на GitHub](https://github.com/qmk/qmk_firmware/issues). Это особенно удобно, когда ваша проблема потребует длительного обсуждения или отладки. diff --git a/docs/ru-ru/getting_started_github.md b/docs/ru-ru/getting_started_github.md deleted file mode 100644 index 7a70926f50..0000000000 --- a/docs/ru-ru/getting_started_github.md +++ /dev/null @@ -1,63 +0,0 @@ -# Как использовать GitHub с QMK - -GitHub может показаться несколько сложным для тех, кто никогда с ним не работал. В данном руководстве будет разобран каждый шаг создания форка, клонирования и отправки пулреквеста в QMK. - -?> В этом руководстве предполагается, что вы в какой-то степени знакомы с работой в командной строке, и в вашей системе установлен git. - -Откройте [страницу QMK на GitHub] (https://github.com/qmk/qmk_firmware), и в правом верхнем углу вы увидите кнопку с надписью "Fork": - - - -Если вы состоите в какой-либо организации, вам нужно выбрать учетную запись, к которой будет привязан форк. В большинстве случаев это будет личной аккаунт. Как только ваш форк будет завершен (иногда это занимает немного времени), нажмите кнопку "Clone or Download": - - -И обязательно выберите "HTTPS", затем выделите ссылку и скопируйте ее: - - - -Теперь введите `git clone --recurse-submodules ` в командную строку, а затем вставьте ссылку: - -``` -user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git -Cloning into 'qmk_firmware'... -remote: Enumerating objects: 9, done. -remote: Counting objects: 100% (9/9), done. -remote: Compressing objects: 100% (5/5), done. -remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874 -Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done. -Resolving deltas: 100% (119972/119972), done. -... -Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b' -Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486' -Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780' -Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d' -``` - -Теперь у вас есть форк QMK на вашем локальном компьютере, и вы можете добавить свою раскладку, скомпилировать ее и прошить ей свою клавиатуру. Как только вы будете довольны своими изменениями, есть возможность добавить, зафиксировать их и сделать коммит в свой форк следующим образом: - -``` -user@computer:~$ git add . -user@computer:~$ git commit -m "adding my keymap" -[master cccb1608] adding my keymap - 1 file changed, 1 insertion(+) - create mode 100644 keyboards/planck/keymaps/mine/keymap.c -user@computer:~$ git push -Counting objects: 1, done. -Delta compression using up to 4 threads. -Compressing objects: 100% (1/1), done. -Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done. -Total 1 (delta 1), reused 0 (delta 0) -remote: Resolving deltas: 100% (1/1), completed with 1 local objects. -To https://github.com/whoeveryouare/qmk_firmware.git - + 20043e64...7da94ac5 master -> master -``` - -Ваши изменения теперь существуют в вашем форке на GitHub - если вернуться туда (`https://github.com/<whoeveryouare>/qmk_firmware`), вы сможете создать "New Pull Request" нажатием на кнопку: - - - -Здесь вы сможете увидеть, какие именно изменения были внесены, - если все выглядит хорошо, вы можете завершить его, нажав "Create Pull Request": - - - -После отправки мы можем расспросить вас о ваших изменениях, попросить внести корректировки и в конечном итоге принять их! Спасибо за ваш вклад в QMK :) diff --git a/docs/ru-ru/getting_started_introduction.md b/docs/ru-ru/getting_started_introduction.md deleted file mode 100644 index ccc4418068..0000000000 --- a/docs/ru-ru/getting_started_introduction.md +++ /dev/null @@ -1,58 +0,0 @@ -# Введение - -Эта страница пытается объяснить основную информацию, которую вы должны знать, чтобы работать с проектом QMK. Предполагается, что вы знакомы с навигацией в оболочке Unix, но не предполагается, что вы знакомы с C или с компиляцией с использованием make. - -## Базовая структура QMK - -QMK - это форк [Джуна Вако (Jun Wako)](https://github.com/tmk) проекта [tmk_keyboard](https://github.com/tmk/tmk_keyboard). Оригинальный код TMK с изменениями можно найти в папке `tmk_core`. Дополнения QMK к проекту можно найти в папке `quantum`. Проекты клавиатур можно найти в папках `handwired` и `keyboard`. - -### Структура пространства пользователя - -Внутри папки `users` находится каталог для каждого пользователя. Это место для пользователей, куда они могут поместить код, чтобы использовать его с разными клавиатурами. Для получения дополнительной информации обратитесь к документации по [функциям пользовательского пространства](ru-ru/feature_userspace.md). - -### Структура проекта клавиатуры - -Внутри папки `keyboards` есть подпапки `handwired` и есть подкаталоги поставщиков и производителей, для примера, `clueboard` - это каталог для каждого проекта клавиатуры, например, `qmk_firmware/keyboards/clueboard/2x1800`. В нем вы найдете следующую структуру: -* `keymaps/`: Различные раскладки клавиш, которые можно собрать. -* `rules.mk`: Файл, который устанавливает параметры по умолчанию для команды "make". Не редактируйте этот файл напрямую, вместо этого используйте `rules.mk`, относящийся к конкретной раскладке. -* `config.h`: Файл, который устанавливает параметры времени компиляции по умолчанию. Не редактируйте этот файл напрямую, вместо этого используйте `config.h`, относящийся к конкретной раскладке. -* `info.json`: Файл настройки раскладки для QMK Configurator. Посмотрите [Поддержку конфигуратора](ru-ru/reference_configurator_support.md) для дополнительной информации. -* `readme.md`: Краткий обзор клавиатуры. -* `<keyboardName>.h`: В этом файле определяется раскладка клавиатуры по матрице переключателей клавиатуры. -* `<keyboardName>.c`: В этом файле вы можете найти пользовательский код для клавиатуры. - -Для получения дополнительной информации о структуре проекта обратитесь к [Руководству QMK по клавиатуре](ru-ru/hardware_keyboard_guidelines.md). - -### Структура раскладки клавиатуры - -В каждой папке раскладки клавиатуры могут быть найдены следующие файлы. Обязательным является только файл `keymap.c`, и если остальные файлы не найдены, то будут выбраны параметры по умолчанию. - -* `config.h`: настройки вашей раскладки клавиатуры. -* `keymap.c`: весь код вашей раскладки клавиатуры (обязателен). -* `rules.mk`: активированные функции QMK. -* `readme.md`: описание вашей раскладки клавиш, как ее могут использовать другие, и объяснения функций. Пожалуйста, загрузите изображения на сервис, такой как imgur. - -# Файл `config.h` - -Существует 3 возможных местоположения `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 - -// Переопределения производятся здесь! -#undef MY_SETTING -#define MY_SETTING 4 -``` diff --git a/docs/ru-ru/newbs.md b/docs/ru-ru/newbs.md deleted file mode 100644 index 0e7bd6499c..0000000000 --- a/docs/ru-ru/newbs.md +++ /dev/null @@ -1,23 +0,0 @@ -# Руководство по QMK для полных новичков - -QMK ― это мощная прошивка с открытым исходным кодом для вашей механической клавиатуры. Вы можете использовать QMK для легкой и мощной персонализации своей клавиатуры. Люди с разным уровнем умений, от совсем новичков до крутых программистов, успешно применяли QMK, чтобы персонализировать свои клавиатуры. Данное руководство поможет вам сделать то же самое, независимо от уровня вашего мастерства. - -Не уверены, поддерживает ли ваша клавиатура QMK? Если это механическая клавиатура, которую вы собрали сами, шансы достаточно велики. Мы поддерживаем [большое число любительских клавиатур](https://qmk.fm/keyboards/), поэтому, даже если ваша текущая клавиатура не совместима с QMK, у вас не должно возникнуть проблем с нахождением подходящей для ваших нужд. - -## Обзор - -В данном руководстве 7 основных секций: - -* [Первое знакомство](ru-ru/newbs_getting_started.md) -* [Собираем вашу первую прошивку с помощью командной строки](ru-ru/newbs_building_firmware.md) -* [Собираем вашу первую прошивку с помощью онлайн GUI](ru-ru/newbs_building_firmware_configurator.md) -* [Прошиваем файл прошивки](ru-ru/newbs_flashing.md) -* [Тестируем и отлаживаем](ru-ru/newbs_testing_debugging.md) -* [Лучшие практики по Git](ru-ru/newbs_best_practices.md) -* [Узнайте больше на этих ресурсах](ru-ru/newbs_learn_more_resources.md) - -Данное руководство сосредоточено на помощи тем, кто никогда раньше не компилировал ПО. Приятие решений и рекомендации делаются с учетом именно этого. Существует много альтернативных методов для описанных процедур, и мы поддерживаем большинство из них. Если у вас есть сомнения о том, как выполнить задачу, вы можете [попросить у нас совета](ru-ru/getting_started_getting_help.md). - -## Дополнительные ресурсы - -* [Блог Томаса Баарта (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 deleted file mode 100644 index a301e9adba..0000000000 --- a/docs/ru-ru/newbs_getting_started.md +++ /dev/null @@ -1,102 +0,0 @@ -# Введение - -У вашей компьютерной клавиатуры внутри есть процессор, похожий на тот, что внутри вашего компьютера. Этот процессор выполняет программное обеспечение, которое отвечает за обнаружение нажатий клавиш и отсылку сигналов состояния клавиатуры, когда клавиши нажимаются и отпускаются. Роль такого ПО выполняет QMK, детектируя нажатия клавиш и отсылая эту информацию главному компьютеру. Сбор собственной раскладки эквивалентен сборке выполняемой программы для вашей клавиатуры. - -QMK старается дать вам большую силу, оставляя простые вещи легкими и делай сложные — возможными. Вам не надо уметь программировать, чтобы создавать мощные прошивки — вам только надо следовать нескольким простым синтаксическим правилам. - -# Первое знакомство - -Перед тем, как вы сможете собирать раскладки, вам необходимо установить некоторое программное обеспечение и настроить ваше окружение для сборки. Это нужно сделать только один раз, вне зависимости от того, для скольких клавиатур вы планируете компилировать прошивки. - -Если вы предпочитаете графический пользовательский интерфейс, пожалуйста, рассмотрите возможность использования онлайн [QMK Конфигуратора](https://config.qmk.fm). Пожалуйста, обратитесь к [Собираем вашу первую прошивку с помощью онлайн GUI](ru-ru/newbs_building_firmware_configurator.md). - - -## Загрузка ПО - -### Текстовый редактор - -Вам понадобится программа, умеющая редактировать и сохранять **обычные текстовые** файлы. Если вы используете Windows, вы можете делать это Блокнотом, а в Linux вы можете использовать gedit. Обе программы являются простыми, но функциональными редакторами. В macOS остерегайтесь стандартного приложения TextEdit: он не будет сохранять обычные текстовые файлы, пока вы явно не выберите _Make Plain Text_ из меню _Format_. - -Вы также можете скачать и установить отдельный текстовый редактор наподобие [Sublime Text](https://www.sublimetext.com/) или [VS Code](https://code.visualstudio.com/). Возможно, это наилучший вариант независимо от платформы, поскольку эти программы сделаны специально для редактирования кода. - -?> Не уверены, какой выбрать текстовый редактор? Лоуренс Брэдфорд (Laurence Bradford) написал [отличное введение](https://learntocodewith.me/programming/basics/text-editors/) в тему. - -### QMK Toolbox - -QMK Toolbox является дополнительной графической программой для Windows и macOS, которая позволяет вам разрабатывать и отлаживать вашу клавиатуру. Вы, вероятно, посчитаете ее бесценной для легкого процесса прошивки вашей клавиатуры и просмотра отладочных сообщений, которые она отображает. - -[Скачайте последний выпуск здесь.](https://github.com/qmk/qmk_toolbox/releases/latest) - -* Для Windows: `qmk_toolbox.exe` (переносимое приложение) или `qmk_toolbox_install.exe` (установщик) -* Для macOS: `QMK.Toolbox.app.zip` (переносимое приложение) или `QMK.Toolbox.pkg` (установщик) - -## Настройте ваше окружение - -Мы постарались сделать установку QMK максимально легкой. Вам нужно только подготовить ваше Linux или Unix окружение, после этого позвольте QMK установить все остальное. - -?> Если вы никогда раньше не работали с командной строкой Linux/Unix, существует несколько базовых концептов и команд, которые необходимо выучить. Эти ресурсы дадут вам достаточно знаний, чтобы работать с QMK:<br> -[Обязательные к изучению команды Linux](https://www.guru99.com/must-know-linux-commands.html)<br> -[Несколько базовых команд Unix](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html) - -### Windows - -Вам нужно будет установить MSYS2 и Git. - -* Следуйте инструкциям по установки на [домашней странице MSYS2](https://www.msys2.org). -* Закройте все открытые терминалы MSYS2 и откройте новый терминал MSYS2 MinGW 64-bit. -* Установите Git, выполнив эту команду: `pacman -S git`. - -### macOS - -Вам нужно будет установить Homebrew. Следуйте инструкциям на [домашней странице Homebrew](https://brew.sh). - -После установки Homebrew продолжите чтение с _Установите QMK_. На этом шаге вам надо будет запустить скрипт, который установит остальные пакеты. - -### Linux - -Вам нужно будет установить Git. Скорее всего, он у вас уже есть, но если нет, одна из следующих команд должна установить его: - -* Debian / Ubuntu / Devuan: `apt-get install git` -* Fedora / Red Hat / CentOS: `yum install git` -* Arch: `pacman -S git` - -?> Docker также является вариантом для всех платформ. [Нажмите сюда для получения подробностей.](ru-ru/getting_started_build_tools.md#docker) - -## Установите QMK - -Как только вы настроили ваше Linux/Unix окружение, вы готовы к загрузке QMK. Мы сделаем это при помощи Git, "клонировав" репозиторий QMK. Откройте Терминал или окно MSYS2 MinGW и оставьте его открытым до конца данного руководства. Выполните эти команды внутри него: - -```shell -git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git -cd qmk_firmware -``` - -?> Если вы уже знаете, [как пользоваться GitHub](ru-ru/getting_started_github.md), мы рекомендуем вам вместо этого создать и клонировать свой собственный форк. Если вы не понимаете, что это значит, просто проигнорируйте это сообщение. - -QMK включает в себя скрипт, который поможет вам установить все оставшееся, что вам понадобится. Вы должны запустить его, набрав эту команду: - - util/qmk_install.sh - -## Протестируйте ваше окружение для сборки - -Теперь, когда ваше окружение QMK для сборки настроено, вы можете собрать прошивку для вашей клавиатуры. Начните с попытки собрать раскладку для клавиатуры по умолчанию. У вас должно это получиться с помощью команды в этом формате: - - make <keyboard>:default - -Например, чтобы собрать прошивку для Clueboard 66%, вы введете: - - make clueboard/66/rev3:default - -Когда все закончится, вы должны увидеть большой лог, который заканчивается примерно так: - -``` -Linking: .build/clueboard_66_rev3_default.elf [OK] -Creating load file for flashing: .build/clueboard_66_rev3_default.hex [OK] -Copying clueboard_66_rev3_default.hex to qmk_firmware folder [OK] -Checking file size of clueboard_66_rev3_default.hex [OK] - * The firmware size is fine - 26356/28672 (2316 bytes free) -``` - -# Создаем вашу раскладку - -Теперь вы готовы создать свою персональную раскладку! Для этого перейдите к [Собираем вашу первую прошивку](ru-ru/newbs_building_firmware.md). |