diff --git a/src/gitsync/readme.md b/src/gitsync/readme.md index ef69faf..85746c9 100644 --- a/src/gitsync/readme.md +++ b/src/gitsync/readme.md @@ -12,24 +12,29 @@ ### Вручную 1. Вручную - Скопировать каталог **gitsync/src** на жесткий диск -2. Запустить приложение командой ```oscript.exe <каталог gitsync>\gitsync.os``` +2. Запустить приложение командой `oscript.exe <каталог gitsync>\src\gitsync.os` ### Через пакетный менеджер opm -1. командой ```opm install gitsync``` -2. Запустить командой ```gitsync``` +1. командой `opm install gitsync` +2. Запустить командой `gitsync` # Использование Возможны следующие сценарии использования/организации хранения исходников в репозитариях Git: 1. в одном репозитарии Git хранятся как исходники конфигурации 1С, так и прочие исходники/файлы продукта (например, документация, тесты и прочее) - `рекомендуется` - + Используем режим `Экспорт исходников конфигурации в сторонний репозитарий Git` + + Используем режимы + + `Экспорт исходников конфигурации в сторонний репозитарий Git` + + `Выполнение настройки для начала выгрузки` + + далее штатные инструменты Git - `commit/pull/push` 2. в одном репозитарии хранятся только исходники конфигурации 1С - `не рекомендуется` + Используем режимы + `Подготовка нового репозитария` - если репозитария Гит еще нет + `Клонирование существующего пустого репо` - если уже был создан пустой репозитарий Git + + `Выполнение настройки для начала выгрузки` + + `Синхронизация` ## Экспорт исходников конфигурации в сторонний репозитарий Git @@ -102,8 +107,8 @@ + В файле `AUTHORS` прописать сопоставление пользователей хранилища 1С и пользователей Git -## Синхронизация -Основной режим работы. Аргументы командной строки для запуска: +## Синхронизация +Основной режим работы для сценария `Хранение исходников конфигурации 1С в отдельном репозитарии Git`. Аргументы командной строки для запуска: * <каталог или файл хранилища> * <адрес (url) репозитария> @@ -118,7 +123,7 @@ ## Получение справки -Справку по синтаксису команды можно получить, запустив ```gitsync help <команда>```. Например: +Справку по синтаксису команды можно получить, запустив `gitsync help <команда>`. Например: gitsync help clone gitsync help init @@ -152,10 +157,10 @@ # Синхронизация по нескольким хранилищам -Зачастую удобно настроить регламентную (по расписанию) синхронизацию сразу по нескольким хранилизам 1С. Для этого необходимо подготовить конфигурационный файл с параметрами синхронизации ([пример файла](config-example.xml)) +Зачастую удобно настроить регламентную (по расписанию) синхронизацию сразу по нескольким хранилищам 1С. Для этого необходимо подготовить конфигурационный файл с параметрами синхронизации ([пример файла](config-example.xml)) -Далее, необходимо запустить gitsync с командой all +Далее необходимо запустить gitsync с командой all gitsync all <путь к xml-файлу конфигурации> -Подробнее о параметрах команды ```all``` можно прочитать, запустив ```gitsync help all``` +Подробнее о параметрах команды `all` можно прочитать, запустив `gitsync help all`