Merge pull request #17 from deryugina/master

Corrected the ru-version of "Hello, World!" example

Author: anton-bondarev

ru/examples/embox_hello_world_example_ru.md

@@ -1,6 +1,5 @@
 # Пример “Hello World”
-Для добавления обычного примера команды выводящей сообщение “hello world” необходимо создать файл “hello.c” с исходным кодом на языке Си.
-
+Чтобы написать пример команды "Hello, World!" -- нужно создать файл "hello.c" с исходным кодом на языке "C":
 ```c
 #include <stdio.h>
 
@@ -9,14 +8,18 @@ int main(int argc, char **argv) {
 	return 0;
 }
 ```
-
 И затем добавить описание модуля.
 
 ## Добавление модуля
-Все модули и интерфейсы системы описываются в my-файлах: файлах с расширением .my или имеющих имя Mybuild (без расширения).
-Структурно каждый my-файл содержит объявление пакета, которому принадлежат все определяемые в файле сущности, (опционально) список импортируемых имен из других пакетов, а также определения самих модулей и интерфейсов.
-К примеру, для добавления новой команды для встроенного в ядро командного интерпретатора создадим новый файл Hello.my со следующим содержимым:
+Все модули и интерфейсы системы описываются в "my"-файлах. **"My"-файлы** -- это файлы, имеющие расширение **".my"** или имя **"Mybuild"**.
+
+**Структурно каждый "my"-файл содержит:**
 
+ * объявление пакета, которому принадлежат все определяемые в файле сущности
+ * список импортируемых имен из других пакетов (опционально)
+ * определения самих модулей и интерфейсов
+
+Например, чтобы добавить команду в командный интерпретатор, встроенный в ядро, нужно создать файл "Hello.my" с таким содержанием:
 ```java
 package embox.cmd.tutorial
 
@@ -26,26 +29,28 @@ module hello {
 	source "hello.c"
 }
 ```
+В этом примере мы описали простой модуль с единственным атрибутом "source" -- файлом "hello.c", который будем скомпилирован и связан с ядром, если модуль будет добавлен в сборку.
+
+**Аннотация "@Cmd"** регистрирует модуль в системе как команду встроенного интерпретатора. Это позволяет запускать модуль по имени "hello".
+
+Опциональный **параметр "help"** содержит строку, которая будет выведана при запуске команды “help hello” (если модуль "help" включен в сборку).
 
-В этом примере описывается простой модуль имеющий всего один атрибут (source) - файл с исходным кодом “hello.c”, которых будет скомпилирован и связан с ядром в случае добавления модуля в сборку.
-Аннотация @Cmd регистрирует модуль в системе как команду встроенного интерпретатора, позволяя, таким образом, запускать ее по имени “hello”. Необязательный параметр help содержит строку, которая будет выведана при запуске команды “help hello” (если модуль help также включен в сборку). Аннотация @AutoCmd позволяет использовать привычную функцию main() в качестве точки входа в программу.
+**Аннотация "@AutoCmd"** позволяет использовать привычную функцию "main()" в качестве точки входа в программу.
 
 ### Атрибуты модуля
-Модуль hello достаточно примитивен и не определяет никаких внешних зависимостей или опций. Единственный его атрибут - source - определяет набор исходных файлов для компиляции.
-Опции
-Теперь модифицируем пример таким образом, чтобы строка приветствия задавалась в виде опции. Для этого используется атрибут option. 
-Добавим модулю hello (файл Hello.my) строковую опцию greeting:
+**Модуль "hello"** достаточно примитивен и не определяет никаких внешних зависимостей или опций.
+Единственный его атрибут - "source" - определяет набор исходных файлов для компиляции.
 
+### Опции
+Теперь давайте зададим строку приветствия в виде опции. Для этого мы воспользуемся атрибутом "option" и добавим модулю "hello" опцию "greeting":
 ```c
 // ...
 module hello {
 	// ...
 	option string greeting = "World"
 }
 ```
-
-И модифицируем файл исходного кода hello.c таким образом, чтобы команда после слова “Hello” выводила строку, содержащуюся в значении опции greeting:
-
+И изменим файл "hello.c" таким образом, чтобы команда после слова "Hello" выводила строку, которая содержится в значении опции "greeting":
 ```c
 #define GREETING OPTION_STRING_GET(greeting)
 
@@ -55,8 +60,7 @@ module hello {
 ```
 
 ## Включение в сборку
-Для того, чтобы новый модуль оказался в результирующем образе ядра, его необходимо добавить в конфигурацию сборки, которая описывается в файле conf/mods.conf:
-
+Для того, чтобы новый модуль оказался в результирующем образе ядра, его необходимо добавить в конфигурацию сборки, которая описывается в файле "conf/mods.conf":
 ```
 package genconfig
 
@@ -65,15 +69,20 @@ configuration conf {
 	include embox.cmd.tutorial.hello
 }
 ```
-Для того, чтобы переопределить значение опции, в конфигурации следует задать новые значения для опций в скобках после указания модуля:
-
+Чтобы изменить значение опции, следует указать новое значение в скобках:
 ```
 // ...
 	include embox.cmd.tutorial.hello(greeting="Everyone")
 // ...
 ```
+Как и многие атрибуты модуля, конфигурация поддерживает добавление аннотаций.
+Чаще всего используется аннотация **"@Runlevel"**. Она позволяет загружать модули поэтапно и определять порядок их загрузки.
+
+**Как правило, на ранних стадиях (runlevel=0) загружаются:**
 
-Как и многие атрибуты модуля, конфигурация также поддерживает добавление аннотаций. Наиболее часто используемой является аннотрация @Runlevel, позволяющая разбить загрузку системы на стадии и определить, на каком этапе загружать тот или иной модуль.
+ * драйверы устройств, необходимых для корректного функционирования системы (например, контроллер прерываний)
+ * основные компоненты системы
+Также на ранних стадиях исполняются низкоуровневые тесты и процедуры самодиагностики.
 
-Как правило, на ранних стадиях (runlevel=0) загружаются драйверы устройств, необходимых для корректного функционирования системы (например, контроллер прерываний), основные компоненты системы, а также исполняются низкоуровневые тесты и процедуры самодиагностики. Следует отметить, что runlevel определяет лишь максимальную стадию, на которой должен быть запущен данный модуль. Таким образом, если какой-либо модуль, загружаемый на нулевой стадии, зависит от модуля, загружаемого позже, последний все-равно будет загружен раньше, т.е. на нулевой стадии.
+**Обратите внимание**: порядок загрузки модулей по зависимостям имеет самый высокий приоритет. Поэтому опция "@Runlevel" работает в тех случаях, когда она не противоречит порядку загрузки по зависимостям.