Merge pull request #13 from deryugina/master

anton-bondarev · web-flow · commit 3f4d446e1bf6 · 2023-03-24T16:18:35.000+03:00
Try to improve the structure of ru-documentation
diff --git a/en/embox_quick_start_en.md b/en/embox_quick_start_en.md
@@ -7,31 +7,28 @@ Clone git repository:
 ```
     $ git clone https://github.com/embox/embox
 ```
-Or download as an archive [https://github.com/embox/embox/releases](https://github.com/embox/embox/releases)
-
+Or download as an archive:
+```
+    [https://github.com/embox/embox/releases](https://github.com/embox/embox/releases/)
+```
 ## Work on Windows or MacOS
 ### Please follow the next recommendations:
-
-Download an actual version of PowerShell
-
-[How to download PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.3)
-
-Open PowerShell as an administrator and install WSL2 (please pay your attention to the demands on Windows version)
-
-[How to install WSL2](https://learn.microsoft.com/en-us/windows/wsl/install-manual)
-
+Download an actual version of PowerShell:
 ```
-Before the next step upgrade WSL1 to WSL2 if you did'nt do this(the instruction is in a link above). In other way Embox won't run on Windows
+    [How to download PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.3/)
 ```
+Open PowerShell as an administrator and install WSL2 (please pay your attention to the demands on Windows version):
+```
+    [How to install WSL2](https://learn.microsoft.com/en-us/windows/wsl/install-manual)
+```
+Before the next step upgrade WSL1 to WSL2 if you did'nt do this(the instruction is in a link above). In other way Embox won't run on Windows.
 
-Download Ubuntu from Microsoft Store
-
+### Download Ubuntu from Microsoft Store
 Check yout version of WSL the next way: insert the command below in PowerShell:
 ```
     wsl -l -v
 ```
 Run the commands below in command line of Ubuntu for installing necessary programs:
-
 ```
     sudo apt-get update
     sudo apt-get install unzip
@@ -42,14 +39,15 @@ Run the commands below in command line of Ubuntu for installing necessary progra
     sudo apt-get install python3
     sudo apt-get install python-is-python3
 ```
-Clone version of embox to yourself(use https or ssh)
-
-   git clone <https://github.com/embox/embox.git>
-   git clone <git@github.com:embox/embox.git>
+Clone version of embox to yourself(use https or ssh):
+```
+    git clone <https://github.com/embox/embox.git>
+    git clone <git@github.com:embox/embox.git>
+```
 
 Open the directory of the embox project
 ```
-   cd embox
+    cd embox
 ```
 Run the next three commands
 ```
@@ -59,14 +57,13 @@ Run the next three commands
 ```
 P.S.: If you have any problems with running Embox on Windows -- please check a correctness of the inserted commands.
 If it's correct -- you can use the recommendations from the article(the link is below):
-
-[How to solve problems with WSL](https://learn.microsoft.com/en-us/windows/wsl/troubleshooting)
-
-
+```
+    [How to solve problems with WSL](https://learn.microsoft.com/en-us/windows/wsl/troubleshooting)
+```
 
 ## Enviroment Settings
 Minimal required packages: *make*, *gcc*, (cross-compiler for target platform. see "Cross-compiler installation").
-Optional packages which are recomended to install at once: *build-essential*, *gcc-multilib*, *curl*, *libmpc-dev*, *python*.
+Optional packages, which are recomended to install at once: *build-essential*, *gcc-multilib*, *curl*, *libmpc-dev*, *python*.
 
 For Debian/Ubuntu:
 ```
@@ -96,16 +93,23 @@ or for Debian:
 ```
     $ sudo apt install gcc-arm-none-eabi
 ```
-You can also download the archive with ARM cross-tools from [https://launchpad.net/gcc-arm-embedded](https://launchpad.net/gcc-arm-embedded)
+You can also download the archive with ARM cross-tools from [https://launchpad.net/gcc-arm-embedded](https://launchpad.net/gcc-arm-embedded).
 Extract files from archive and set *PATH* enviroment variable:
 ```
     $ export PATH=$PATH:<path to toolchain>/gcc-arm-none-eabi-<version>/bin
 ```
 
 ***SPARC, Microblaze, MIPS, PowerPC, MSP430***:
 You can try to use some cross-compiler based on gcc in case if you already have a suitable one.
-But it would be better if you will use our project for cross-compiler installation [https://github.com/embox/crosstool](https://github.com/embox/crosstool).
-You can use already ready-to-use archives from [https://github.com/embox/crosstool/releases](https://github.com/embox/crosstool/releases). Or you can build cross-compiler with the script in the project's root folder:
+But it would be better if you will use our project for cross-compiler installation:
+```
+    [https://github.com/embox/crosstool](https://github.com/embox/crosstool)
+```
+You can use already ready-to-use archives from:
+```
+    [https://github.com/embox/crosstool/releases](https://github.com/embox/crosstool/releases)
+```
+Or you can build cross-compiler with the script in the project's root folder:
 ```
     $ ./crosstool.sh ARCH
 ```
@@ -147,28 +151,30 @@ Example of how to build with 4 parallel jobs:
 ```
     $ make -j4
 ```
-
 Now you are able to run Embox:
 ```
     $ ./scripts/qemu/auto_qemu
 ```
 Console output example:
 ```
 Embox kernel start
-	unit: initializing embox.kernel.task.task_resource: done
-	unit: initializing embox.mem.vmem_alloc: done
+    unit: initializing embox.kernel.task.task_resource: done
+    unit: initializing embox.mem.vmem_alloc: done
 ```
 If all unit tests passed successfully and all modules loaded, then command prompt will appear.
 Now you can execute commands included in the configuration (`mods.conf`). You can start with ***help*** command which prints list of available commands.
 
 Press ***ctrl+’A’*** and then `***x***` to exit from Qemu.
 
 ## Preliminaries to Mybuild build system
-Embox is modular and configurable. Declarative program language Mybuild has been developed for these features. Mybuild allows to describe both single modules and whole target system.
+Embox is modular and configurable. Declarative program language "Mybuild" has been developed for these features. Mybuild allows to describe both single modules and whole target system.
+
 A module is a base concept for build system. A module description contains: source files list, options which can be set for the module during configuration, and dependences list.
+
 The configuration is a particular description of the whole system. It contains list of required modules, modules options and build rules (cross-compiler, additional compiler flags, memory map etc.).
+
 Graph of the system will be based on the configuration and modules descriptions.
-Build system then generates different build artifacts: linker scripts, makefiles, headers.
+Build system, that generates different build artifacts: linker scripts, makefiles, headers.
 It's not necesary to include all modules, they will be enabled using dependencies for each module included in the initial configuration list.
 
 Current configuration locates in ***conf/*** folder. It can be set up with:
@@ -179,8 +185,7 @@ For example, to set up demo configuration for qemu-arm you should do the followi
 ```
     $ make confload-arm/qemu
 ```
-
-Use 
+Use: 
 ```
     $ make confload
 ```
@@ -198,22 +203,18 @@ Source code of Embox application is usual POSIX program written in C, and so can
 To add your own simplest application "Hello world" you can do the following:
 
 * Create folder *hello_world* in *src/cmds*:
-
 ```
      $ mkdir src/cmds/hello_world
 ```
 * Create *src/cmds/hello_world/hello_world.c*:
-
 ```
      #include <stdio.h>
 
      int main(int argc, char **argv) {
           printf("Hello, world!\n");
      }
 ```
-
 * Create file *src/cmds/hello_world/Mybuild* with your module description:
-
 ```
      package embox.cmd
 
@@ -223,27 +224,19 @@ To add your own simplest application "Hello world" you can do the following:
      	source "hello_world.c"
      }
 ```
-
 * Now add the application into your configuration *conf/mods.conf*:
-
 ```
      include embox.cmd.hello_world
 ```
-
 * Build Embox:
-
 ```
      $ make
 ```
-
  * Run Embox:
-
 ```
      $ ./scripts/qemu/auto_qemu
 ```
-
  * Type ***help*** in Embox console to check if there is ***hello_world*** in commands list. Execute ***hello_world*** command and you will see:
-
 ```
      root@embox:/#hello_world
      Hello, world!
@@ -252,7 +245,6 @@ To add your own simplest application "Hello world" you can do the following:
 
 ### Mybuild file for "Hello World"
 Let's look at the Mybuild file from "Hello world" example in more details:
-
 ```
      package embox.cmd
 
@@ -262,21 +254,20 @@ Let's look at the Mybuild file from "Hello world" example in more details:
      	source "hello_world.c"
      }
 ```
-
 The first line contains package name ***embox.cmd***. In Embox all modules are organized into packages.
 Full module name consist of the corresponding package name appended with module name. Module name is defined in string ***module hello_world***.
 
 ## Debugging
 You can use the same script with *-s -S -no-kvm* flags for debugging:
 ```
-$ sudo ./scripts/qemu/auto_qemu -s -S -no-kvm
+    $ sudo ./scripts/qemu/auto_qemu -s -S -no-kvm
 ```
 After running that QEMU waits for a connection from a gdb-client. Run gdb in the other terminal:
 ```
-$ gdb ./build/base/bin/embox
-...
-(gdb) target extended-remote :1234
-(gdb) continue
+    $ gdb ./build/base/bin/embox
+    ...
+    (gdb) target extended-remote :1234
+    (gdb) continue
 ```
 The system starts to load.
 
diff --git a/ru/drivers/embox_driver_example_ru.md b/ru/drivers/embox_driver_example_ru.md
@@ -1 +1,2 @@
 # Пример добавления драйвера
+Раздел в разработке
diff --git a/ru/examples/embox_blinking_led_example_ru.md b/ru/examples/embox_blinking_led_example_ru.md
@@ -85,3 +85,4 @@ int main(int argc, char *argv[]) {
 ```
 
 Отличие от примера с простым миганием светодиодом заключается в использовании еще одного вывода, который переключен в режим прерывания с помощью функции gpio_setup_mode(). А с помощью функции gpio_irq_attach() на событие по изменению состояния на выводе подключенном к кнопке, повешен обработчик. В обработчике происходит инвертирование значения на выходе светодиода.
+
diff --git a/ru/examples/embox_external_app_example_ru.md b/ru/examples/embox_external_app_example_ru.md
diff --git a/ru/examples/embox_hello_world_example_ru.md b/ru/examples/embox_hello_world_example_ru.md
diff --git a/ru/platforms/embox_supported_platforms_arm_ru.md b/ru/platforms/embox_supported_platforms_arm_ru.md
@@ -10,4 +10,3 @@ Embox поддерживает несколько популярных аппа
  * IMX6
  * Raspberry Pi
  * BeagleBoard
-
diff --git a/ru/platforms/embox_supported_platforms_qemu_ru.md b/ru/platforms/embox_supported_platforms_qemu_ru.md
@@ -30,4 +30,3 @@ make
         $ ./scripts/qemu/auto_qemu
 ```
 данный скрипт разберет содержимое конфигурационных файлов в папке conf/ и запустит qemu c нужными параметрами. Для каждой архитектуры будет выбрана своя платформа по умолчанию.
-
diff --git a/ru/platforms/embox_supported_platforms_ru.md b/ru/platforms/embox_supported_platforms_ru.md
diff --git a/ru/platforms/embox_supported_platforms_x86_ru.md b/ru/platforms/embox_supported_platforms_x86_ru.md
@@ -7,4 +7,3 @@ Embox поддерживает:
  * qemu-system-i386
  * Загрузка через GRUB
  * BifferBoard
-

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`# Пример добавления драйвера`
	`2`	`+Раздел в разработке`
Original file line number	Diff line number	Diff line change
`@@ -85,3 +85,4 @@ int main(int argc, char *argv[]) {`
`85`	`85`	```
`86`	`86`
`87`	`87`	Отличие от примера с простым миганием светодиодом заключается в использовании еще одного вывода, который переключен в режим прерывания с помощью функции gpio_setup_mode(). А с помощью функции gpio_irq_attach() на событие по изменению состояния на выводе подключенном к кнопке, повешен обработчик. В обработчике происходит инвертирование значения на выходе светодиода.
	`88`	`+`