Browse Source

fix some typos in README

mtroshechkin 2 years ago
parent
commit
3784495b6e
1 changed files with 7 additions and 8 deletions
  1. 7 8
      README.md

+ 7 - 8
README.md

@@ -4,14 +4,14 @@
 
 
 Данный репозиторий является единой кодовой базой для всех устрйоств линейки BT-67xx, сборка под каждое устройство определяется параметрами команды `make`. Коды поддерживаемых устройств перечислены в файле `jenkins-env.groovy` (переменная devices = []). Эти же коды используются в релизных тегах.
 Данный репозиторий является единой кодовой базой для всех устрйоств линейки BT-67xx, сборка под каждое устройство определяется параметрами команды `make`. Коды поддерживаемых устройств перечислены в файле `jenkins-env.groovy` (переменная devices = []). Эти же коды используются в релизных тегах.
 #### ВНИМАНИЕ! 
 #### ВНИМАНИЕ! 
-Коды для команды make отличаются. Они должны быть написаны ТОЛЬКО с использованием знака "_".
+Параметры для команды make отличаются по написанию от кодов типа устройства. Параметры должны быть написаны ТОЛЬКО с использованием знака "_".
 Все имеющиеся коды устройств и параметры для команды `make` перечислены в таблице:
 Все имеющиеся коды устройств и параметры для команды `make` перечислены в таблице:
 
 
 | Код | Параметр сборки | Примечание |
 | Код | Параметр сборки | Примечание |
 | -------- | -------- | -------- |
 | -------- | -------- | -------- |
 | bt6703 | `HARDWARE=bt6703` | Билайн |
 | bt6703 | `HARDWARE=bt6703` | Билайн |
-| bt6703 | `HARDWARE=bt6703_rt` | Ростелеком |
-| bt6703 | `HARDWARE=bt6707` |  |
+| bt6703-rt | `HARDWARE=bt6703_rt` | Ростелеком |
+| bt6707 | `HARDWARE=bt6707` |  |
 | bt6709 | `HARDWARE=bt6709` | Билайн |
 | bt6709 | `HARDWARE=bt6709` | Билайн |
 | bt6709-mts | `HARDWARE=bt6709_mts` | МТС |
 | bt6709-mts | `HARDWARE=bt6709_mts` | МТС |
 | bt6710 | `HARDWARE=bt6710` |  |
 | bt6710 | `HARDWARE=bt6710` |  |
@@ -36,17 +36,16 @@ docker run \
 Все релизы ПО осуществляются по тегам. Теги проставляются только по определенному шаблону.
 Все релизы ПО осуществляются по тегам. Теги проставляются только по определенному шаблону.
 Все теги, проставленные не по шаблону, не учитываются системой сборки и несут вспомогательный характер (удобство разработчика)
 Все теги, проставленные не по шаблону, не учитываются системой сборки и несут вспомогательный характер (удобство разработчика)
 
 
-Для выпуска релиз кандидата нужно проставить тег с префиксом `rc_`:
+Для выпуска релиз кандидата нужно проставить тег с префиксом "rc_":<br />
 `rc_<тип устройства>_<версия>` (Пример: `rc_bt6710_v1.5beta2`)
 `rc_<тип устройства>_<версия>` (Пример: `rc_bt6710_v1.5beta2`)
 
 
-Для сборки релиза нужно проставить тег с префиксом `release_`:
+Для сборки релиза нужно проставить тег с префиксом "release_":<br />
 `release_<тип устройства>_<версия>` (Пример: `release_bt6710_v1.5`)
 `release_<тип устройства>_<версия>` (Пример: `release_bt6710_v1.5`)
 
 
-Возможно так же оформить отдельно релиз загрузчика (префикс `bootloader_`)<br />
-и релиз сервисной флешки (префикс `service_`)
+Пайплайн позволяет также осуществить релиз загрузчика (префикс "bootloader_") и релиз сервисной флешки (префикс "service_") отдельно от основного ПО.
 
 
 ## Автоматическая сборка
 ## Автоматическая сборка
 * Сборка осуществляется на сервере Jenkins в пайплайне: http://192.168.24.203:8080/view/BT-67xx/job/bt-67xx_universal_hw/. В нем настроены сборки при каждом коммите в ветку `master` и при обнаружении нового тега (независимо от ветки). В любом случае система собирает все возможные варианты ПО (для всех вариантов контроллеров), но при релизе публикует только ПО для выбранного устройства.
 * Сборка осуществляется на сервере 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/
 * Результаты сборки попадают на сервер Artifactory http://192.168.24.227:8082/ui/native/firmware/BT-67xx/bt67xx_universal_hw/
 * Переменные окружения (настройки) для автоматической сборки, с их подробным описанием, хранятся в файле `jenkins-env.groovy` в корне данного репозитория.
 * Переменные окружения (настройки) для автоматической сборки, с их подробным описанием, хранятся в файле `jenkins-env.groovy` в корне данного репозитория.
-* По окончанию сборки релиза всем указанным в настройках адресатам рассылается информационное письмо со ссылкой на хранилище результатам сборки. <br />Так же информационное письмо отправляется разработчику при неудачных сборках очередного коммита в основную ветку.
+* По окончанию сборки релиза всем указанным в настройках адресатам рассылается информационное письмо со ссылкой на хранилище результатам сборки. Так же информационное письмо отправляется разработчику при неудачных сборках очередного коммита в основную ветку.