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 721878154..000000000 --- a/docs/ru-ru/README.md +++ /dev/null | |||
@@ -1,31 +0,0 @@ | |||
1 | # Quantum Mechanical Keyboard Firmware | ||
2 | |||
3 | [](https://github.com/qmk/qmk_firmware/tags) | ||
4 | [](https://discord.gg/Uq7gcHh) | ||
5 | [](https://docs.qmk.fm) | ||
6 | [](https://github.com/qmk/qmk_firmware/pulse/monthly) | ||
7 | [](https://github.com/qmk/qmk_firmware/) | ||
8 | |||
9 | ## Что такое QMK Firmware? | ||
10 | |||
11 | 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. Вы можете использовать ее для клавиатуры, собранной вручную или имеющей нестандартную печатную плату. | ||
12 | |||
13 | ## Как скачать | ||
14 | |||
15 | Если вы собираетесь добавить раскладку, клавиатуру или новые функции в QMK, то самый простой путь реализации — это [сделать форк репозитория на GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box), клонировать ваш репозиторий локально для дальнейшего внесения изменений, сделать пуш изменений, а затем открыть [пулреквест](https://github.com/qmk/qmk_firmware/pulls) из вашего форка. | ||
16 | |||
17 | Также вы можете либо скачать репозиторий ([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`). | ||
18 | |||
19 | ## Как скомпилировать | ||
20 | |||
21 | Перед компиляцией вам необходимо [настроить окружение](ru-ru/getting_started_build_tools.md) разработчика для AVR или/и ARM. После этого используйте команду `make` со следующим синтаксисом, чтобы собрать клавиатуру и раскладку: | ||
22 | |||
23 | make planck/rev4:default | ||
24 | |||
25 | Данная команда соберет ревизию `rev4` клавиатуры `planck` с раскладкой `default`. Не все клавиатуры имеют ревизии (они также называются subprojects или folders), в этом случае она может быть опущена: | ||
26 | |||
27 | make preonic:default | ||
28 | |||
29 | ## Как настроить | ||
30 | |||
31 | 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 09273172b..000000000 --- a/docs/ru-ru/_summary.md +++ /dev/null | |||
@@ -1,124 +0,0 @@ | |||
1 | * [Complete Newbs Guide](ru-ru/newbs.md) | ||
2 | * [Getting Started](ru-ru/newbs_getting_started.md) | ||
3 | * [Building Your First Firmware](ru-ru/newbs_building_firmware.md) | ||
4 | * [Flashing Firmware](ru-ru/newbs_flashing.md) | ||
5 | * [Testing and Debugging](ru-ru/newbs_testing_debugging.md) | ||
6 | * [Git Best Practices](ru-ru/newbs_best_practices.md) | ||
7 | * [Learning Resources](ru-ru/newbs_learn_more_resources.md) | ||
8 | |||
9 | * [QMK Basics](ru-ru/README.md) | ||
10 | * [QMK Introduction](ru-ru/getting_started_introduction.md) | ||
11 | * [QMK CLI](ru-ru/cli.md) | ||
12 | * [QMK CLI Config](ru-ru/cli_configuration.md) | ||
13 | * [Contributing to QMK](ru-ru/contributing.md) | ||
14 | * [How to Use GitHub](ru-ru/getting_started_github.md) | ||
15 | * [Getting Help](ru-ru/getting_started_getting_help.md) | ||
16 | |||
17 | * [Breaking Changes](ru-ru/breaking_changes.md) | ||
18 | * [2019 Aug 30](ru-ru/ChangeLog/20190830.md) | ||
19 | |||
20 | * [FAQ](ru-ru/faq.md) | ||
21 | * [General FAQ](ru-ru/faq_general.md) | ||
22 | * [Build/Compile QMK](ru-ru/faq_build.md) | ||
23 | * [Debugging/Troubleshooting QMK](ru-ru/faq_debug.md) | ||
24 | * [Keymap](ru-ru/faq_keymap.md) | ||
25 | * [Driver Installation with Zadig](ru-ru/driver_installation_zadig.md) | ||
26 | |||
27 | * Detailed Guides | ||
28 | * [Install Build Tools](ru-ru/getting_started_build_tools.md) | ||
29 | * [Vagrant Guide](ru-ru/getting_started_vagrant.md) | ||
30 | * [Build/Compile Instructions](ru-ru/getting_started_make_guide.md) | ||
31 | * [Flashing Firmware](ru-ru/flashing.md) | ||
32 | * [Customizing Functionality](ru-ru/custom_quantum_functions.md) | ||
33 | * [Keymap Overview](ru-ru/keymap.md) | ||
34 | |||
35 | * [Hardware](ru-ru/hardware.md) | ||
36 | * [Compatible Microcontrollers](ru-ru/compatible_microcontrollers.md) | ||
37 | * [AVR Processors](ru-ru/hardware_avr.md) | ||
38 | * [Drivers](ru-ru/hardware_drivers.md) | ||
39 | |||
40 | * Reference | ||
41 | * [Keyboard Guidelines](ru-ru/hardware_keyboard_guidelines.md) | ||
42 | * [Config Options](ru-ru/config_options.md) | ||
43 | * [Keycodes](ru-ru/keycodes.md) | ||
44 | * [Coding Conventions - C](ru-ru/coding_conventions_c.md) | ||
45 | * [Coding Conventions - Python](ru-ru/coding_conventions_python.md) | ||
46 | * [Documentation Best Practices](ru-ru/documentation_best_practices.md) | ||
47 | * [Documentation Templates](ru-ru/documentation_templates.md) | ||
48 | * [Glossary](ru-ru/reference_glossary.md) | ||
49 | * [Unit Testing](ru-ru/unit_testing.md) | ||
50 | * [Useful Functions](ru-ru/ref_functions.md) | ||
51 | * [Configurator Support](ru-ru/reference_configurator_support.md) | ||
52 | * [info.json Format](ru-ru/reference_info_json.md) | ||
53 | * [Python CLI Development](ru-ru/cli_development.md) | ||
54 | |||
55 | * [Features](ru-ru/features.md) | ||
56 | * [Basic Keycodes](ru-ru/keycodes_basic.md) | ||
57 | * [US ANSI Shifted Keys](ru-ru/keycodes_us_ansi_shifted.md) | ||
58 | * [Quantum Keycodes](ru-ru/quantum_keycodes.md) | ||
59 | * [Advanced Keycodes](ru-ru/feature_advanced_keycodes.md) | ||
60 | * [Audio](ru-ru/feature_audio.md) | ||
61 | * [Auto Shift](ru-ru/feature_auto_shift.md) | ||
62 | * [Backlight](ru-ru/feature_backlight.md) | ||
63 | * [Bluetooth](ru-ru/feature_bluetooth.md) | ||
64 | * [Bootmagic](ru-ru/feature_bootmagic.md) | ||
65 | * [Combos](ru-ru/feature_combo.md) | ||
66 | * [Command](ru-ru/feature_command.md) | ||
67 | * [Debounce API](ru-ru/feature_debounce_type.md) | ||
68 | * [DIP Switch](ru-ru/feature_dip_switch.md) | ||
69 | * [Dynamic Macros](ru-ru/feature_dynamic_macros.md) | ||
70 | * [Encoders](ru-ru/feature_encoders.md) | ||
71 | * [Grave Escape](ru-ru/feature_grave_esc.md) | ||
72 | * [Haptic Feedback](ru-ru/feature_haptic_feedback.md) | ||
73 | * [HD44780 LCD Controller](ru-ru/feature_hd44780.md) | ||
74 | * [Key Lock](ru-ru/feature_key_lock.md) | ||
75 | * [Layouts](ru-ru/feature_layouts.md) | ||
76 | * [Leader Key](ru-ru/feature_leader_key.md) | ||
77 | * [LED Matrix](ru-ru/feature_led_matrix.md) | ||
78 | * [Macros](ru-ru/feature_macros.md) | ||
79 | * [Mouse Keys](ru-ru/feature_mouse_keys.md) | ||
80 | * [OLED Driver](ru-ru/feature_oled_driver.md) | ||
81 | * [One Shot Keys](ru-ru/one_shot_keys.md) | ||
82 | * [Pointing Device](ru-ru/feature_pointing_device.md) | ||
83 | * [PS/2 Mouse](ru-ru/feature_ps2_mouse.md) | ||
84 | * [RGB Lighting](ru-ru/feature_rgblight.md) | ||
85 | * [RGB Matrix](ru-ru/feature_rgb_matrix.md) | ||
86 | * [Space Cadet](ru-ru/feature_space_cadet.md) | ||
87 | * [Split Keyboard](ru-ru/feature_split_keyboard.md) | ||
88 | * [Stenography](ru-ru/feature_stenography.md) | ||
89 | * [Swap Hands](ru-ru/feature_swap_hands.md) | ||
90 | * [Tap Dance](ru-ru/feature_tap_dance.md) | ||
91 | * [Terminal](ru-ru/feature_terminal.md) | ||
92 | * [Thermal Printer](ru-ru/feature_thermal_printer.md) | ||
93 | * [Unicode](ru-ru/feature_unicode.md) | ||
94 | * [Userspace](ru-ru/feature_userspace.md) | ||
95 | * [Velocikey](ru-ru/feature_velocikey.md) | ||
96 | |||
97 | * For Makers and Modders | ||
98 | * [Hand Wiring Guide](ru-ru/hand_wire.md) | ||
99 | * [ISP Flashing Guide](ru-ru/isp_flashing_guide.md) | ||
100 | * [ARM Debugging Guide](ru-ru/arm_debugging.md) | ||
101 | * [I2C Driver](ru-ru/i2c_driver.md) | ||
102 | * [SPI Driver](ru-ru/spi_driver.md) | ||
103 | * [WS2812 Driver](ru-ru/ws2812_driver.md) | ||
104 | * [GPIO Controls](ru-ru/internals_gpio_control.md) | ||
105 | * [Proton C Conversion](ru-ru/proton_c_conversion.md) | ||
106 | |||
107 | * For a Deeper Understanding | ||
108 | * [How Keyboards Work](ru-ru/how_keyboards_work.md) | ||
109 | * [Understanding QMK](ru-ru/understanding_qmk.md) | ||
110 | |||
111 | * Other Topics | ||
112 | * [Using Eclipse with QMK](ru-ru/other_eclipse.md) | ||
113 | * [Using VSCode with QMK](ru-ru/other_vscode.md) | ||
114 | * [Support](ru-ru/getting_started_getting_help.md) | ||
115 | * [Translating the QMK Docs](ru-ru/translating.md) | ||
116 | |||
117 | * QMK Internals (In Progress) | ||
118 | * [Defines](ru-ru/internals_defines.md) | ||
119 | * [Input Callback Reg](ru-ru/internals_input_callback_reg.md) | ||
120 | * [Midi Device](ru-ru/internals_midi_device.md) | ||
121 | * [Midi Device Setup Process](ru-ru/internals_midi_device_setup_process.md) | ||
122 | * [Midi Util](ru-ru/internals_midi_util.md) | ||
123 | * [Send Functions](ru-ru/internals_send_functions.md) | ||
124 | * [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 322f9a9e5..000000000 --- a/docs/ru-ru/getting_started_build_tools.md +++ /dev/null | |||
@@ -1,153 +0,0 @@ | |||
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, [установите его!](https://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, скачайте его и следуйте дальнейшим указаниям отсюда: https://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, поэтому установите ее, следуя [иснтрукциям здесь](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`. | ||
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 | ## Docker | ||
123 | |||
124 | Если это немного сложновато для вас, Docker может стать готовым решением, которое вы ищите. После установки [Docker CE](https://docs.docker.com/install/#supported-platforms) выполните следующую команду из директории `qmk_firmware`, чтобы собрать клавиатуру/раскладку: | ||
125 | |||
126 | ```bash | ||
127 | util/docker_build.sh keyboard:keymap | ||
128 | # Например: util/docker_build.sh ergodox_ez:steno | ||
129 | ``` | ||
130 | |||
131 | Это скомпилирует указанную клавиатуру/раскладку и создаст для вас `.hex` или `.bin` файл с результатом, готовым к процессу прошивки, в директории QMK. Если опустить `:keymap`, будет использована раскладка `default`. Заметьте, что формат параметров такой же, как и в случае сборки командой `make`. | ||
132 | |||
133 | Вы также можете запустить скрипт без параметров. Тогда он попросит вас ввести поочередно параметры сборки. Возможно, вам это покажется более удобным: | ||
134 | |||
135 | ```bash | ||
136 | util/docker_build.sh | ||
137 | # Читает параметры из пользовательского ввода (оставьте пустым для значений по умолчанию) | ||
138 | ``` | ||
139 | |||
140 | Также имеется поддержка сборки _и_ прошивки клавиатуры прямо из Docker. Для этого укажите еще один параметр `target`: | ||
141 | |||
142 | ```bash | ||
143 | util/docker_build.sh keyboard:keymap:target | ||
144 | # Например: util/docker_build.sh planck/rev6:default:dfu-util | ||
145 | ``` | ||
146 | |||
147 | Если вы используете 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). | ||
148 | |||
149 | !> 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**. | ||
150 | |||
151 | ## Vagrant | ||
152 | |||
153 | Если у вас возникли проблемы при сборке прошивки, вы можете попробовать установить инструмент под названием 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 75be44310..000000000 --- a/docs/ru-ru/getting_started_getting_help.md +++ /dev/null | |||
@@ -1,15 +0,0 @@ | |||
1 | # Получение помощи | ||
2 | |||
3 | Существует много ресурсов для получения помощи по работе с QMK. | ||
4 | |||
5 | ## Чат в реальном времени | ||
6 | |||
7 | Вы можете найти разработчиков и пользователей QMK на нашем главном [сервере Discord](https://discord.gg/Uq7gcHh). На сервере есть специальные каналы для разговоров о прошивке, Toolbox, оборудовании и конфигураторе. | ||
8 | |||
9 | ## OLKB Сабреддит | ||
10 | |||
11 | Официальный форум QMK [/r/olkb](https://reddit.com/r/olkb) на [reddit.com](https://reddit.com). | ||
12 | |||
13 | ## GitHub ишью | ||
14 | |||
15 | Вы можете открыть [ишью на 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 7a70926f5..000000000 --- a/docs/ru-ru/getting_started_github.md +++ /dev/null | |||
@@ -1,63 +0,0 @@ | |||
1 | # Как использовать GitHub с QMK | ||
2 | |||
3 | GitHub может показаться несколько сложным для тех, кто никогда с ним не работал. В данном руководстве будет разобран каждый шаг создания форка, клонирования и отправки пулреквеста в QMK. | ||
4 | |||
5 | ?> В этом руководстве предполагается, что вы в какой-то степени знакомы с работой в командной строке, и в вашей системе установлен git. | ||
6 | |||
7 | Откройте [страницу QMK на GitHub] (https://github.com/qmk/qmk_firmware), и в правом верхнем углу вы увидите кнопку с надписью "Fork": | ||
8 | |||
9 |  | ||
10 | |||
11 | Если вы состоите в какой-либо организации, вам нужно выбрать учетную запись, к которой будет привязан форк. В большинстве случаев это будет личной аккаунт. Как только ваш форк будет завершен (иногда это занимает немного времени), нажмите кнопку "Clone or Download": | ||
12 |  | ||
13 | |||
14 | И обязательно выберите "HTTPS", затем выделите ссылку и скопируйте ее: | ||
15 | |||
16 |  | ||
17 | |||
18 | Теперь введите `git clone --recurse-submodules ` в командную строку, а затем вставьте ссылку: | ||
19 | |||
20 | ``` | ||
21 | user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git | ||
22 | Cloning into 'qmk_firmware'... | ||
23 | remote: Enumerating objects: 9, done. | ||
24 | remote: Counting objects: 100% (9/9), done. | ||
25 | remote: Compressing objects: 100% (5/5), done. | ||
26 | remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874 | ||
27 | Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done. | ||
28 | Resolving deltas: 100% (119972/119972), done. | ||
29 | ... | ||
30 | Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b' | ||
31 | Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486' | ||
32 | Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780' | ||
33 | Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d' | ||
34 | ``` | ||
35 | |||
36 | Теперь у вас есть форк QMK на вашем локальном компьютере, и вы можете добавить свою раскладку, скомпилировать ее и прошить ей свою клавиатуру. Как только вы будете довольны своими изменениями, есть возможность добавить, зафиксировать их и сделать коммит в свой форк следующим образом: | ||
37 | |||
38 | ``` | ||
39 | user@computer:~$ git add . | ||
40 | user@computer:~$ git commit -m "adding my keymap" | ||
41 | [master cccb1608] adding my keymap | ||
42 | 1 file changed, 1 insertion(+) | ||
43 | create mode 100644 keyboards/planck/keymaps/mine/keymap.c | ||
44 | user@computer:~$ git push | ||
45 | Counting objects: 1, done. | ||
46 | Delta compression using up to 4 threads. | ||
47 | Compressing objects: 100% (1/1), done. | ||
48 | Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done. | ||
49 | Total 1 (delta 1), reused 0 (delta 0) | ||
50 | remote: Resolving deltas: 100% (1/1), completed with 1 local objects. | ||
51 | To https://github.com/whoeveryouare/qmk_firmware.git | ||
52 | + 20043e64...7da94ac5 master -> master | ||
53 | ``` | ||
54 | |||
55 | Ваши изменения теперь существуют в вашем форке на GitHub - если вернуться туда (`https://github.com/<whoeveryouare>/qmk_firmware`), вы сможете создать "New Pull Request" нажатием на кнопку: | ||
56 | |||
57 |  | ||
58 | |||
59 | Здесь вы сможете увидеть, какие именно изменения были внесены, - если все выглядит хорошо, вы можете завершить его, нажав "Create Pull Request": | ||
60 | |||
61 |  | ||
62 | |||
63 | После отправки мы можем расспросить вас о ваших изменениях, попросить внести корректировки и в конечном итоге принять их! Спасибо за ваш вклад в QMK :) | ||
diff --git a/docs/ru-ru/getting_started_introduction.md b/docs/ru-ru/getting_started_introduction.md deleted file mode 100644 index ccc441806..000000000 --- a/docs/ru-ru/getting_started_introduction.md +++ /dev/null | |||
@@ -1,58 +0,0 @@ | |||
1 | # Введение | ||
2 | |||
3 | Эта страница пытается объяснить основную информацию, которую вы должны знать, чтобы работать с проектом QMK. Предполагается, что вы знакомы с навигацией в оболочке Unix, но не предполагается, что вы знакомы с C или с компиляцией с использованием make. | ||
4 | |||
5 | ## Базовая структура QMK | ||
6 | |||
7 | QMK - это форк [Джуна Вако (Jun Wako)](https://github.com/tmk) проекта [tmk_keyboard](https://github.com/tmk/tmk_keyboard). Оригинальный код TMK с изменениями можно найти в папке `tmk_core`. Дополнения QMK к проекту можно найти в папке `quantum`. Проекты клавиатур можно найти в папках `handwired` и `keyboard`. | ||
8 | |||
9 | ### Структура пространства пользователя | ||
10 | |||
11 | Внутри папки `users` находится каталог для каждого пользователя. Это место для пользователей, куда они могут поместить код, чтобы использовать его с разными клавиатурами. Для получения дополнительной информации обратитесь к документации по [функциям пользовательского пространства](ru-ru/feature_userspace.md). | ||
12 | |||
13 | ### Структура проекта клавиатуры | ||
14 | |||
15 | Внутри папки `keyboards` есть подпапки `handwired` и есть подкаталоги поставщиков и производителей, для примера, `clueboard` - это каталог для каждого проекта клавиатуры, например, `qmk_firmware/keyboards/clueboard/2x1800`. В нем вы найдете следующую структуру: | ||
16 | * `keymaps/`: Различные раскладки клавиш, которые можно собрать. | ||
17 | * `rules.mk`: Файл, который устанавливает параметры по умолчанию для команды "make". Не редактируйте этот файл напрямую, вместо этого используйте `rules.mk`, относящийся к конкретной раскладке. | ||
18 | * `config.h`: Файл, который устанавливает параметры времени компиляции по умолчанию. Не редактируйте этот файл напрямую, вместо этого используйте `config.h`, относящийся к конкретной раскладке. | ||
19 | * `info.json`: Файл настройки раскладки для QMK Configurator. Посмотрите [Поддержку конфигуратора](ru-ru/reference_configurator_support.md) для дополнительной информации. | ||
20 | * `readme.md`: Краткий обзор клавиатуры. | ||
21 | * `<keyboardName>.h`: В этом файле определяется раскладка клавиатуры по матрице переключателей клавиатуры. | ||
22 | * `<keyboardName>.c`: В этом файле вы можете найти пользовательский код для клавиатуры. | ||
23 | |||
24 | Для получения дополнительной информации о структуре проекта обратитесь к [Руководству QMK по клавиатуре](ru-ru/hardware_keyboard_guidelines.md). | ||
25 | |||
26 | ### Структура раскладки клавиатуры | ||
27 | |||
28 | В каждой папке раскладки клавиатуры могут быть найдены следующие файлы. Обязательным является только файл `keymap.c`, и если остальные файлы не найдены, то будут выбраны параметры по умолчанию. | ||
29 | |||
30 | * `config.h`: настройки вашей раскладки клавиатуры. | ||
31 | * `keymap.c`: весь код вашей раскладки клавиатуры (обязателен). | ||
32 | * `rules.mk`: активированные функции QMK. | ||
33 | * `readme.md`: описание вашей раскладки клавиш, как ее могут использовать другие, и объяснения функций. Пожалуйста, загрузите изображения на сервис, такой как imgur. | ||
34 | |||
35 | # Файл `config.h` | ||
36 | |||
37 | Существует 3 возможных местоположения `config.h`: | ||
38 | |||
39 | * клавиатура (`/keyboards/<keyboard>/config.h`) | ||
40 | * пространство пользователя (`/users/<user>/config.h`) | ||
41 | * раскладка клавиш (`/keyboards/<keyboard>/keymaps/<keymap>/config.h`) | ||
42 | |||
43 | Система сборки автоматически загружает файлы конфигурации в указанном выше порядке. Если вы хотите переопределить любую настройку, заданную предыдущим `config.h`, вам сначала нужно будет включить некоторый шаблонный код для настроек, которые вы хотите изменить. | ||
44 | |||
45 | ``` | ||
46 | #pragma once | ||
47 | ``` | ||
48 | |||
49 | Затем, чтобы переопределить настройку из предыдущего файла `config.h`, вы должны сделать `#undef` и `#define` для неё снова. | ||
50 | |||
51 | Код и настройка шаблона вместе выглядят так: | ||
52 | ``` | ||
53 | #pragma once | ||
54 | |||
55 | // Переопределения производятся здесь! | ||
56 | #undef MY_SETTING | ||
57 | #define MY_SETTING 4 | ||
58 | ``` | ||
diff --git a/docs/ru-ru/newbs.md b/docs/ru-ru/newbs.md deleted file mode 100644 index 0e7bd6499..000000000 --- a/docs/ru-ru/newbs.md +++ /dev/null | |||
@@ -1,23 +0,0 @@ | |||
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 deleted file mode 100644 index a301e9adb..000000000 --- a/docs/ru-ru/newbs_getting_started.md +++ /dev/null | |||
@@ -1,102 +0,0 @@ | |||
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). | ||