Merge pull request #59 from Untru/docs/01

Правка ошибок ридми

README.md

@@ -1,16 +1,21 @@
 ## GitManager
 Что это и зачем?
 
-Изначально была цель дать пользователю простой нитерфейс для работы с 1с по методологии Git Flow. Решение представляет из себя 3 коомпонента:
+Изначально была цель дать пользователю простой интерфейс для работы с 1с по методологии Git Flow. 
+Решение построено на БСП.
+
+Решение представляет из себя 3 компонента:
+
+
 * GitManager 
-* GitAgent
+* GitAgent (Опционально)
 * Cli приложение (https://github.com/Untru/pivo-cli)
 
-GitManager и GitAgent Это одна и та жа конфигурация. Идея сделать GitAgent родилась изза того что по сети сборка и разборка исходников работает очень долго, по этому основная база отправляет команды в GitAgent И он уже запускает скрипты.
+
+GitManager и GitAgent Это одна конфигурация. Идея сделать GitAgent родилась из-за того что по сети сборка и разборка исходников работает очень долго, по этому основная база отправляет команды в GitAgent И он уже запускает скрипты. Работать можно и без GitAgent, для этого надо установить константе СтратегияЗапускаСкрипта - CMD
 
 Общая схема работы:
 
-
 ```mermaid
 sequenceDiagram
     participant GitManager as GitManager (Сервер 1)
@@ -33,7 +38,8 @@ sequenceDiagram
 Для удобства работы мы сделали скрипт по разворачиванию базы (РазворачиваниеБазы.bat)
 
 Необходимо заполнить переменные, система сама скачает файл с репозитория и развернет базу на сервере.
-Основные тесты были с серверной базой, по этому в файловой гарантирвтаь работоспособность нам сложно.
+Основные тесты были с серверной базой, по этому работа в файловой базе не гарантируется.
+
 <details>
  <summary><strong> Скрипт </strong></summary>
 
@@ -91,7 +97,7 @@ pause
 </details>
 
 Для удобста старта работ мы разработали "Начальный помошник", Управление разработкой - > Запуск.
-Советую пройтись по всем шагам по очередит и заодно изучить что создается, 
+Советую пройтись по всем шагам по очереди и заодно изучить структуру объектов.
 
 <img src="images/image-7.png" width="600" alt="Начальный помощник">
 
@@ -123,7 +129,6 @@ pause
 <img src="images/image-5.png" width="600" alt="Права доступа">
 </details>
 
-
 Необходимо запустить RAC как службу
 Сделать это можно с помощью скрипта
 
@@ -148,27 +153,18 @@ sc create %SrvcName% binPath= %BinPath% start= auto obj= %SrvUserName% password=
 
 </details>
 
-Важно, с системе получние настроек для задач
-
-Для вывода логов от 1command (Блиблиотека запуска команд)
-Мы можем или зададать переменную окружения
-
-``` bat 
-set LOGOS_CONFIG=logger.oscript.lib.commands=DEBUG;
-```
-
-<img src="images/image-9.png" width="600" alt="Запуск команд">
-
-
 ## Процесс работы
 
-Каждой базе должен соответствовать своя папочка подключенная к репозиторию, это проверить можно по наличию кнопки создания репозитория
+Каждой базе должнга соответствовать своя папка, подключенная к репозиторию. 
+Это проверить можно по наличию кнопки создания репозитория:
 
 ![alt text](images/image-11.png)
 
 
 ### Создаем задачу
-Новая задача - > 
+
+Важно, с системе получние настроек для задач.
+
 ![alt text](images/image-10.png)
 Тут есть 3 варианта:
 * Новая задача - создается новая ветка из ветки Develop
@@ -200,11 +196,12 @@ curl --location 'https:/Путь К Базе/hs/tasks/task?id=000000002'
 ```
 * Битрикс 
 
-Задача должна появится в списке, прошу обратить внимание 
+Задача должна появиться в списке, прошу обратить внимание на кнопки:
+![alt text](images/image-13.png)
 
 ### Переходим на ветку
 
-Во время перехода происходит переход в папке базы репозитория на переход на нужную ветку, и загрузка в базу
+Во время перехода папка базы репозитория переключается на выбранную в списке ветку задачи, далее происходит загрузка в базу:
 * Основной конфигурации, если стоит галочка
  ![alt text](images/image-12.png)
 * Загрузка расширений указанных в задаче
@@ -213,26 +210,43 @@ curl --location 'https:/Путь К Базе/hs/tasks/task?id=000000002'
 
 ### Зафиксировать изменения
 
-Разбор указанного в задачи на исходники (Конфигурация и расширения). Разбор внешних обработок из папки
+Разбор объектов указанных в задаче на исходники (Конфигурация и расширения). 
+Разбор внешних обработок/отчетов происходит из папки
 build\epf
 
-### Создание мерд реквеста
+### Создание мердж реквеста
 В случае если это GITHUB - необходим GITHUB-CLI
 
 
 ### Другие возможности
-* Создание внешних обработоток по шаблону
+* Создание новых внешних обработоток по шаблону
 * Загрузки обработок в бд 
 * Подготовка релиза и быстрое обновление баз
+* Управление списком задач в виде канбан доски
+* Анализ сделанных коммитов
+
+### Получение расширенных логов
+Для вывода логов от 1commands (Блиблиотека запуска команд https://github.com/artbear/1commands)
+Мы можем зададать переменную окружения
+
+``` bat 
+set LOGOS_CONFIG=logger.oscript.lib.commands=DEBUG;
+```
+Или добавить команды которые будет запускаться перед основными
+<img src="images/image-9.png" width="600" alt="Запуск команд">
 
 # ВАЖНО
-Так как инзначально инструмент разрабатывался для нужд комапни и подгонялась под требования много функционала сейчас возможно работат не будет. мы старались добавить универсальности решению.
+Так как инзначально инструмент разрабатывался для нужд компании и подгонялся под требования, некоторый функционал не оттустирован в парадигме универсальности.
-Если вы захотите развернуть инструмент у себя. Обращайтесь за помощью, любые ваши вопросы помогут дописать руководство и поправить найденные замечания.
 
-Так же вся чески приветствуются Ишузы.
+Если вы захотите развернуть инструмент у себя и что-то не получается - смело пишите. Обращайтесь за помощью, любые ваши вопросы помогут дописать руководство и поправить найденные замечания.
 
-Использование чужих библиотек
+Так же всячески приветствуются issues.
+
+
+Использование опенсорс библиотек
 - ОПИ (https://github.com/Bayselonarrend/OpenIntegrations)
-
+- GitCodeReview (https://github.com/salexdv/git_code_reviews)
+- КоннекторHTTP ()
+- Oscript (autumn, autumn-cli, autumn-logos, 1connector, v8rac, v8runner, gitrunner, ibcmdrunner)
 
 ОГРАНИЧЕНИЯ !!! Некоторый функционал не работает в WEB Клиенте