Обновить 'README.md'

README.md

@@ -2,6 +2,21 @@
 Сборка осуществляется командой `make HARDWARE=<hw> VERBOSE=1 DEBUG=0 PRINTF=custom MAC=<mac_adr>`
 Пример: `make HARDWARE=bt6711_v1 VERBOSE=1 DEBUG=0 PRINTF=custom MAC=EC-4C-4D-00-EE-DC`
 
+Данный репозиторий является единой кодовой базой для всех устрйоств линейки BT-67xx, сборка под каждое устройство определяется параметрами команды `make`. Коды поддерживаемых устройств перечислены в файле `jenkins-env.groovy` (переменная devices = []). Эти же коды используются в релизных тегах.
+#### ВНИМАНИЕ! 
+Коды для команды make отличаются. Они должны быть написаны ТОЛЬКО с использованием знака "_".
+Все имеющиеся коды устройств и параметры для команды `make` перечислены в таблице:
+| Код | Параметр сборки | Примечание |
+| -------- | -------- | -------- |
+| bt6703 | `HARDWARE=bt6703` | Билайн |
+| bt6703 | `HARDWARE=bt6703_rt` | Ростелеком |
+| bt6703 | `HARDWARE=bt6707` |  |
+| bt6709 | `HARDWARE=bt6709` | Билайн |
+| bt6709-mts | `HARDWARE=bt6709_mts` | МТС |
+| bt6710 | `HARDWARE=bt6710` |  |
+| bt6711 | `HARDWARE=bt6711` |  |
+| bt6711-v1 | `HARDWARE=bt6711_v1` |  |
+
 Возможна сборка в докер-контейнере с подготовленным окружением и необходимым тулчейном. Актуальный образ для сборки указан в файле `jenkins-env.groovy` (переменная `buildenvImage`). Полная команда для сборки в таком случае выглядит так:
 ```
 git clone https://192.168.24.200:3000/ebalbekova/bt-67xx_universal_hw.git 
@@ -13,8 +28,9 @@ docker run \
 ```
 Сборка при помощи докера является предпочтительным способом отладки ПО разработчиком. В этом случае исключены ошибки при несовпадении окружения на ПК разработчика и на сервере автосборки.
 ## Ветвление
-Основная ветка для разработки - `master`
-Иные ветки несут вспомогательный (временный) характер для разработки или отладки отдельных функций. Сборка этих веток автоматически не осуществляется.
+Основная ветка для разработки - `master`. <br />
+Иные ветки несут вспомогательный (временный) характер для разработки новых фич или отладки отдельных функций. Автоматическая сборка этих веток не осуществляется.
+
 ## Тегирование
 Все релизы ПО осуществляются по тегам. Теги проставляются только по определенному шаблону.
 Все теги, проставленные не по шаблону, не учитываются системой сборки и несут вспомогательный характер (удобство разработчика)
@@ -29,7 +45,7 @@ docker run \
 и релиз сервисной флешки (префикс `service_`)
 
 ## Автоматическая сборка
-Сборка осуществляется на сервере Jenkins в пайплайне: http://192.168.24.203:8080/view/BT-67xx/job/bt-67xx_universal_hw/
-Настроены сборки при каждом коммите в ветку `master` и при обнаружении нового тега (независимо от ветки). В любом случае система собирает все возможные варианты ПО (для всех вариантов контроллеров), но при релизе публикует только ПО для выбранного устройства.
-Результаты сборки попадают на сервер Artifactory http://192.168.24.227:8082/ui/native/firmware/BT-67xx/bt67xx_universal_hw/
-Все настройки для автоматической сборки (с подробным описанием) хранятся в файле `jenkins-env.groovy` в корне данного репозитория. По окончании сборки релиза всем указанным в настройках адресатам рассылается информационное письмо со ссылкой на хранилище результатам сборки. Так же информационное письмо отправляется разработчику при неудачных сборках очередного коммита в основную ветку.
+* Сборка осуществляется на сервере Jenkins в пайплайне: http://192.168.24.203:8080/view/BT-67xx/job/bt-67xx_universal_hw/. В нем настроены сборки при каждом коммите в ветку `master` и при обнаружении нового тега (независимо от ветки). В любом случае система собирает все возможные варианты ПО (для всех вариантов контроллеров), но при релизе публикует только ПО для выбранного устройства.
+* Результаты сборки попадают на сервер Artifactory http://192.168.24.227:8082/ui/native/firmware/BT-67xx/bt67xx_universal_hw/
+* Переменные окружения (настройки) для автоматической сборки, с их подробным описанием, хранятся в файле `jenkins-env.groovy` в корне данного репозитория.
+* По окончанию сборки релиза всем указанным в настройках адресатам рассылается информационное письмо со ссылкой на хранилище результатам сборки. <br />Так же информационное письмо отправляется разработчику при неудачных сборках очередного коммита в основную ветку.