Update embox_quick_start_ru.md

deryugina · deryugina · commit f7f1906c8ece · 2023-03-31T16:59:26.000+03:00
diff --git a/ru/embox_quick_start_ru.md b/ru/embox_quick_start_ru.md
@@ -17,10 +17,8 @@
 Зайдите в PowerShell под именем администратора и установите WSL2 (обратите внимание на требования к версии Windows):
 
 [Алгоритм установки WSL2](https://learn.microsoft.com/ru-ru/windows/wsl/install-manual)
-```
-    Перед тем как перейти к следующему шагу обязательно обновите WSL1 до WSL2
-    (инструкция по ссылкам выше), в противном случае Embox не запустится под Windows.
-```
+
+Перед тем как перейти к следующему шагу обязательно обновите WSL1 до WSL2 (инструкция по ссылкам выше), в противном случае Embox не запустится под Windows.
 
 ### Скачайте Ubuntu из Microsoft Store
 Убедитесь, что у Вас стоит WSL версии 2, для этого введите в PowerShell команду:
@@ -61,7 +59,7 @@
 
 
 ## Настройка окружения
-Необходимые пакеты: **make**, **gcc** (кросс-компилятор под выбранную архитектуру,  см. “Установка кросс-компилятора”).
+Необходимые пакеты: **make**, **gcc** (кросс-компилятор под выбранную архитектуру, см. следующий абзац «Установка кросс-компилятора»).
 Дополнительные пакеты (рекомендуется установить сразу): **build-essential**, **gcc-multilib**, **curl**, **libmpc-dev**, **python**.
 
 Пример установки для Ubuntu/Debian:
@@ -80,19 +78,19 @@
 ```
      $ sudo apt-get install gcc
 ```
-Обычно эти пакеты уже установлены в Вашей ОС, но на всякий случай стоит это проверить. Вам также понадобится *gcc-multilib*.
+Обычно эти пакеты уже установлены в Вашей ОС, но на всякий случай стоит это проверить. Вам также понадобится `gcc-multilib`.
 Обратите внимание, что требуется установить другие пакеты, если Вы уже настроили окружение на Windows и MacOS самостоятельно.
 
 ### ARM:
 ```
      $ sudo apt install arm-none-eabi-gcc
 ```
-Или для Debian:
+### Или для Debian:
 ```
     $ sudo apt install gcc-arm-none-eabi
 ```
 Вы можете также скачать архив с набором ARM-инструментов(тулчейном) по ссылке: [https://launchpad.net/gcc-arm-embedded](https://launchpad.net/gcc-arm-embedded).
-Затем нужно распаковать архив и настроить переменную окружения *PATH*:
+Затем нужно распаковать архив и настроить переменную окружения `PATH`:
 ```
    $ export PATH=$PATH:<путь к тулчейну>/gcc-arm-none-eabi-<version>/bin
 ```
@@ -106,7 +104,7 @@
 ```
     $ ./crosstool.sh ARCH
 ```
-После должен появиться архив с тулчейном — *ARCH-elf-toolchain.tar.bz2*. Затем его нужно распаковать и добавить в переменную окружения *PATH*, как показано выше для ARM.
+После должен появиться архив с тулчейном — `ARCH-elf-toolchain.tar.bz2`. Затем его нужно распаковать и добавить в переменную окружения `PATH`, как показано выше для ARM.
 
 ## Установка эмулятора QEMU
 Поддерживаемые архитектуры: x86, ARM, MIPS, Sparc, PPC, Microblaze.
@@ -115,7 +113,7 @@ QEMU может быть установлен следующим способо
 ```
     $ sudo apt-get install qemu-system-<ARCH> 
 ```
-где <ARCH> это i386, arm, sparc, mips, ppc или misc (для microblaze).
+где <ARCH> -- это i386, arm, sparc, mips, ppc или misc (для microblaze).
 Примечание: Все пакеты QEMU можно установить единым пакетом:
 ```
     $ sudo apt-get install qemu-system
@@ -159,17 +157,25 @@ Embox kernel start
 ```
 Если все unit-тесты прошли успешно, и система загружена, появится консоль, в которой можно выполнять команды. Начать можно с команды ***'help'*** которая выведет список доступных команд для вашей конфигурации.
 
-Для выхода из эмулятора qemu нажмите последовательно: ***ctrl+’A’***, затем ***‘x’***.
+Для выхода из эмулятора qemu нажмите последовательно: ***ctrl+"A"***, затем ***"x"***.
 
 ## Особенности системы сборки Mybuild
 ***Embox*** - модульная и настраиваемая система. Для этих целей был разработан декларативный язык описания ***Mybuild***.
 Он позволяет описывать как отдельные единицы системы (модули), так и всю систему в целом.
 
-***Модуль*** является базовым понятием для системы сборки. Он содержит: список файлов, относящихся к данному модулю; параметры, которые можно задать модулю в момент конфигурации; список зависимостей.
-
-***Конфигурация*** является детализированным описанием системы. Конфигурация включает в себя: список модулей, необходимых для сборки; параметры модулей; описания правил сборки (компилятор, флаги компилятора, карта памяти устройства, и так далее). 
+***Модуль*** -- это базовое понятие для системы сборки.
+    Модуль содержит: 
+    * список файлов, относящихся к данному модулю;
+    * параметры, которые можно задать модулю в момент конфигурации;
+    * список зависимостей.
+
+***Конфигурация*** -- это детализированное описание системы.
+    Конфигурация включает в себя:
+    * список модулей, необходимых для сборки;
+    * параметры модулей;
+    * описания правил сборки (компилятор, флаги компилятора, карта памяти устройства, и т. д.). 
     
-На основе конфигурации и описания модулей строится граф с параметрами системы, и по нему генерируются различные файлы для сборки: линкер скрипты, makefile-ы, заголовочные файлы. Нет необходимости добавлять все модули, т. к. они будут подтягиваться по зависимостям.
+На основе конфигурации и описания модулей строится граф с параметрами системы, и по нему генерируются различные файлы для сборки: `линкер`, `скрипты`, `makefile-ы`, `заголовочные файлы`. Нет необходимости добавлять все модули, т. к. они будут подтягиваться по зависимостям.
 
 Текущая конфигурация находится в папке ***conf/***. Вы можете настроить её с помощью команды:
 ```
@@ -183,7 +189,7 @@ Embox kernel start
 ```
     $ make confload
 ```
-После того, как Вы настроили какую-либо конфигурацию, Вы можете кастомизировать её под свои требования.
+После того, как Вы настроили какую-либо конфигурацию, Вы можете кастомизировать её под свои требования:
 ```
     include <PACKAGE_NAME><MODULE_NAME>
 ```
@@ -194,6 +200,7 @@ Embox kernel start
 
 ## Создание и запуск "Hello world"
 Приложение в Embox -- это обычный модуль Embox со специальными аттрибутами. Эти аттрибуты определяют Ваш модуль как выполняемую программу.
+
 Исходный код в Embox -- это обычный POSIX-код, написанный на C, поэтому он может компилироваться и под Linux.
 
 ### Создание и запуск примера
@@ -221,7 +228,7 @@ Embox kernel start
         	source "hello_world.c"
         }
 ```
-* Добавить программу в файл конфигурации *conf/mods.conf*:
+* Добавить программу в файл конфигурации ***conf/mods.conf***:
 ```
         include embox.cmd.hello_world
 ```
@@ -233,15 +240,15 @@ Embox kernel start
 ```
         $ ./scripts/qemu/auto_qemu
 ```
-* Наберите **help** в консоли Embox, чтобы проверить, появилась ли **hello_world** в списке команд, и Вы увидите:
+* Наберите ***help*** в консоли Embox, чтобы проверить, появилась ли ***hello_world*** в списке команд, и Вы увидите:
 ```
         root@embox:/#hello_world 
         Hello, world!
         root@embox:/#
 ```
 
 ### Файл описания модуля
-Разберем немного подробнее файл описания модуля.
+Разберем немного подробнее файл описания модуля:
 ```
         package embox.cmd
 
@@ -253,16 +260,18 @@ Embox kernel start
 ```
 Первая строка содержит в себе пакет с названием **embox.cmd.**. В Embox все модули распределены по пакетам. Полное имя модуля состояит из имени пакета + имени модуля.
 
-Строка ***source "hello_world.c"*** содержит названия необходимых для сборки модуля файлов.
+Строка source «hello_world.c» содержит названия необходимых для сборки модуля файлов.
+
+В строке ***@Cmd(name = «hello_world», help=«First Embox application»)*** задается атрибут модуля.
 
-В строке ***@Cmd(name = "hello_world", help="First Embox application")*** задается атрибут модуля.
 В первую очередь модуль будет представлять из себя приложение, а во вторую -- устанавливает имя, с помощью которого это приложение можно вызвать.
+
 И наконец, устанавливается строка, которая будет отображаться при вызове команды ***'help'***.
     
 Строка ***@AutoCmd*** показывает, что в приложении есть стандартная функция входа в приложение ***main()***, которая будет заменена на другой символ в процессе сборки.
 
 ## Отладка
-Для отладки можно использовать тот же 'auto_qemu' скрипт, добавив флаги *-s -S -no-kvm*:
+Для отладки можно использовать тот же «auto_qemu» скрипт, добавив флаги `-s`, `-S`, `-no-kvm`:
 ```
     $ sudo ./scripts/qemu/auto_qemu -s -S -no-kvm
 ```
@@ -275,7 +284,7 @@ Embox kernel start
 ```
 Система начала загружаться.
 
-В любой момент в gdb терминале Вы можете нажать *ctrl + C* и посмотреть стек текущего потока (`backtrace`) или установить брейкпоинты (`break <function name>`, `break <file name>:<line number>`).
+В любой момент в gdb терминале Вы можете нажать `ctrl + C` и посмотреть стек текущего потока (`backtrace`) или установить брейкпоинты (`break <function name>`, `break <file name>:<line number>`).
 
 ## Подключение внешнего репозитория для модулей и темплейтов
 Embox допускает подключение внешнего репозитория для модулей и темлейтов. Для того, чтобы это сделать, достаточно указать корневую папку репозитория:
