aboutsummaryrefslogtreecommitdiff
path: root/docs/ru-ru
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ru-ru')
-rw-r--r--docs/ru-ru/_summary.md123
-rw-r--r--docs/ru-ru/becoming_a_qmk_collaborator.md9
-rw-r--r--docs/ru-ru/getting_started_build_tools.md15
-rw-r--r--docs/ru-ru/getting_started_getting_help.md15
-rw-r--r--docs/ru-ru/getting_started_github.md58
-rw-r--r--docs/ru-ru/getting_started_introduction.md58
6 files changed, 263 insertions, 15 deletions
diff --git a/docs/ru-ru/_summary.md b/docs/ru-ru/_summary.md
new file mode 100644
index 000000000..3269ac86d
--- /dev/null
+++ b/docs/ru-ru/_summary.md
@@ -0,0 +1,123 @@
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/feature_advanced_keycodes.md#one-shot-keys)
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 * [WS2812 Driver](ru-ru/ws2812_driver.md)
103 * [GPIO Controls](ru-ru/internals_gpio_control.md)
104 * [Proton C Conversion](ru-ru/proton_c_conversion.md)
105
106* For a Deeper Understanding
107 * [How Keyboards Work](ru-ru/how_keyboards_work.md)
108 * [Understanding QMK](ru-ru/understanding_qmk.md)
109
110* Other Topics
111 * [Using Eclipse with QMK](ru-ru/other_eclipse.md)
112 * [Using VSCode with QMK](ru-ru/other_vscode.md)
113 * [Support](ru-ru/support.md)
114 * [Translating the QMK Docs](ru-ru/translating.md)
115
116* QMK Internals (In Progress)
117 * [Defines](ru-ru/internals_defines.md)
118 * [Input Callback Reg](ru-ru/internals_input_callback_reg.md)
119 * [Midi Device](ru-ru/internals_midi_device.md)
120 * [Midi Device Setup Process](ru-ru/internals_midi_device_setup_process.md)
121 * [Midi Util](ru-ru/internals_midi_util.md)
122 * [Send Functions](ru-ru/internals_send_functions.md)
123 * [Sysex Tools](ru-ru/internals_sysex_tools.md)
diff --git a/docs/ru-ru/becoming_a_qmk_collaborator.md b/docs/ru-ru/becoming_a_qmk_collaborator.md
new file mode 100644
index 000000000..653f01ac8
--- /dev/null
+++ b/docs/ru-ru/becoming_a_qmk_collaborator.md
@@ -0,0 +1,9 @@
1# Стать соавтором QMK
2
3Соавтор QMK - это производитель или разработчик клавиатуры, который заинтересован в том, чтобы помочь QMK вырасти. Для этого он полностью поддерживает свои клавиатуры, поощряет пользователей и клиентов создавать новый функционал, идеи и раскладки клавиатур. Мы всегда стремимся добавлять больше клавиатур и соавторов, но нам важно, чтобы они соответствовали следующим требованиям:
4
5* **Иметь печатную плату на продажу.** К сожалению, у собранных вручную клавиатур слишком много вариаций и сложностей.
6* **Поддерживать вашу клавиатуру в QMK.** Это может потребовать просто начальной настройки, чтобы ваша клавиатура заработала. Но поддержка также может заключаться в адаптации изменений ядра QMK, которые способны сломать или сделать избыточным любой пользовательский код.
7* **Одобрять и производить слияние пулреквестов для вашей клавиатуры.** Мы призываем пользователей делиться своими раскладками клавиатур, чтобы другие могли их видеть и опираться на них при создании своих собственных.
8
9Если вы чувствуете, что удовлетворяете этим требованиям, напишите нам письмо по адресу hello@qmk.fm с кратким описанием и ссылками на вашу клавиатуру!
diff --git a/docs/ru-ru/getting_started_build_tools.md b/docs/ru-ru/getting_started_build_tools.md
index f59068533..facdf3563 100644
--- a/docs/ru-ru/getting_started_build_tools.md
+++ b/docs/ru-ru/getting_started_build_tools.md
@@ -119,21 +119,6 @@ git
119* WSL Git **не** совместим с Windows Git, поэтому используйте Windows Git Bash или Windows Git GUI для всех операций с Git. 119* WSL Git **не** совместим с Windows Git, поэтому используйте Windows Git Bash или Windows Git GUI для всех операций с Git.
120* Вы можете изменять файлы как внутри WSL, так и просто через Windows. Но обратите внимание, что если вы изменяете makefiles или сценарии командной строки, вы должны убедиться, что используете текстовый редактор, который сохраняет файлы с переводом строки в стиле Unix (Unix line endings). В противном случае компиляция может не работать. 120* Вы можете изменять файлы как внутри WSL, так и просто через Windows. Но обратите внимание, что если вы изменяете makefiles или сценарии командной строки, вы должны убедиться, что используете текстовый редактор, который сохраняет файлы с переводом строки в стиле Unix (Unix line endings). В противном случае компиляция может не работать.
121 121
122## Windows (Vista и новее) (устарело)
123
124Это устаревшие инструкции для Windows Vista и более новых версий. Мы рекомендуем использовать [MSYS2, как сказано выше](#windows-с-msys2-рекомендуется).
125
1261. Если вы когда-то устанавливали WinAVR, удалите его.
1272. Установите [MHV AVR Tools](https://infernoembedded.com/sites/default/files/project/MHV_AVR_Tools_20131101.exe). Отключите smatch, но **оставьте галочку напротив опции добавления инструмента в PATH**.
1283. Если вы собираетесь прошивать клавиатуры на базе Infinity, вам нужно установить dfu-util. Обратитесь к инструкциям от [Input Club](https://github.com/kiibohd/controller/wiki/Loading-DFU-Firmware).
1294. Установите [MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download). Во время установки отключите опцию установки графического пользовательского интерфейса. **НЕ ИЗМЕНЯЙТЕ директорию для установки по умолчанию.** Скрипты зависят от расположения по умолчанию.
1305. Выполните клонирование данного репозитория. [Эта ссылка скачает его в виде zip-файла, который вам нужно будет разархивировать.](https://github.com/qmk/qmk_firmware/archive/master.zip) Откройте извлеченную папку в проводнике Windows.
1316. Перейдите в папку `\util`.
1327. Запустите двойным щелчком пакетный файл сценария `1-setup-path-win`. Вам нужно будет согласиться с уведомлением контроля учетных записей пользователей (User Account Control, UAC). Нажмите пробел, чтобы закрыть появившееся сообщение об успешном выполнении операции в командной строке.
1338. Кликните правой кнопкой по пакетному файлу сценария `2-setup-environment-win`, выберите "Запуск от имени администратора" и согласитесь с уведомлением UAC. Это может занять пару минут, и вам потребуется подтвердить установку драйвера. Как только сценарий завершит свою работу, ваше окружение будет готово!
134
135Если у вас возникли проблемы и вам нужна помощь, будет полезно сгенерировать файл *Win_Check_Output.txt*, запустив `Win_Check.bat` в папке `\util`.
136
137## Docker 122## Docker
138 123
139Если это немного сложновато для вас, Docker может стать готовым решением, которое вы ищите. После установки [Docker CE](https://docs.docker.com/install/#supported-platforms) выполните следующую команду из директории `qmk_firmware`, чтобы собрать клавиатуру/раскладку: 124Если это немного сложновато для вас, Docker может стать готовым решением, которое вы ищите. После установки [Docker CE](https://docs.docker.com/install/#supported-platforms) выполните следующую команду из директории `qmk_firmware`, чтобы собрать клавиатуру/раскладку:
diff --git a/docs/ru-ru/getting_started_getting_help.md b/docs/ru-ru/getting_started_getting_help.md
new file mode 100644
index 000000000..75be44310
--- /dev/null
+++ b/docs/ru-ru/getting_started_getting_help.md
@@ -0,0 +1,15 @@
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
new file mode 100644
index 000000000..8a0fd07a2
--- /dev/null
+++ b/docs/ru-ru/getting_started_github.md
@@ -0,0 +1,58 @@
1# Как использовать GitHub с QMK
2
3GitHub может показаться несколько сложным для тех, кто никогда с ним не работал. В данном руководстве будет разобран каждый шаг создания форка, клонирования и отправки пулреквеста в QMK.
4
5?> В этом руководстве предполагается, что вы в какой-то степени знакомы с работой в командной строке, и в вашей системе установлен git.
6
7Откройте [страницу QMK на GitHub] (https://github.com/qmk/qmk_firmware), и в правом верхнем углу вы увидите кнопку с надписью "Fork":
8
9![Fork on Github](http://i.imgur.com/8Toomz4.jpg)
10
11Если вы состоите в какой-либо организации, вам нужно выбрать учетную запись, к которой будет привязан форк. В большинстве случаев это будет личной аккаунт. Как только ваш форк будет завершен (иногда это занимает немного времени), нажмите кнопку "Clone or Download":
12![Download from Github](http://i.imgur.com/N1NYcSz.jpg)
13
14И обязательно выберите "HTTPS", затем выделите ссылку и скопируйте ее:
15
16![HTTPS link](http://i.imgur.com/eGO0ohO.jpg)
17
18Теперь введите `git clone` в командную строку, а затем вставьте ссылку:
19
20```
21user@computer:~$ git clone https://github.com/whoeveryouare/qmk_firmware.git
22Cloning into 'qmk_firmware'...
23remote: Counting objects: 46625, done.
24remote: Compressing objects: 100% (2/2), done.
25remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623
26Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done.
27Resolving deltas: 100% (29362/29362), done.
28Checking out files: 100% (2799/2799), done.
29```
30
31Теперь у вас есть форк QMK на вашем локальном компьютере, и вы можете добавить свою раскладку, скомпилировать ее и прошить ей свою клавиатуру. Как только вы будете довольны своими изменениями, есть возможность добавить, зафиксировать их и сделать коммит в свой форк следующим образом:
32
33```
34user@computer:~$ git add .
35user@computer:~$ git commit -m "adding my keymap"
36[master cccb1608] adding my keymap
37 1 file changed, 1 insertion(+)
38 create mode 100644 keyboards/planck/keymaps/mine/keymap.c
39user@computer:~$ git push
40Counting objects: 1, done.
41Delta compression using up to 4 threads.
42Compressing objects: 100% (1/1), done.
43Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done.
44Total 1 (delta 1), reused 0 (delta 0)
45remote: Resolving deltas: 100% (1/1), completed with 1 local objects.
46To https://github.com/whoeveryouare/qmk_firmware.git
47 + 20043e64...7da94ac5 master -> master
48```
49
50Ваши изменения теперь существуют в вашем форке на GitHub - если вернуться туда (`https://github.com/<whoeveryouare>/qmk_firmware`), вы сможете создать "New Pull Request" нажатием на кнопку:
51
52![New Pull Request](http://i.imgur.com/DxMHpJ8.jpg)
53
54Здесь вы сможете увидеть, какие именно изменения были внесены, - если все выглядит хорошо, вы можете завершить его, нажав "Create Pull Request":
55
56![Create Pull Request](http://i.imgur.com/Ojydlaj.jpg)
57
58После отправки мы можем расспросить вас о ваших изменениях, попросить внести корректировки и в конечном итоге принять их! Спасибо за ваш вклад в QMK :)
diff --git a/docs/ru-ru/getting_started_introduction.md b/docs/ru-ru/getting_started_introduction.md
new file mode 100644
index 000000000..142fe4254
--- /dev/null
+++ b/docs/ru-ru/getting_started_introduction.md
@@ -0,0 +1,58 @@
1# Введение
2
3Эта страница пытается объяснить основную информацию, которую вы должны знать, чтобы работать с проектом QMK. Предполагается, что вы знакомы с навигацией в оболочке Unix, но не предполагается, что вы знакомы с C или с компиляцией с использованием make.
4
5## Базовая структура QMK
6
7QMK - это форк [Джуна Вако (Jun Wako)](https://github.com/tmk) проекта [tmk_keyboard](https://github.com/tmk/tmk_keyboard). Оригинальный код TMK с изменениями можно найти в папке `tmk`. Дополнения 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```