From ae072ed5e7cf79b9eeb1eb273121fcc1dfe74077 Mon Sep 17 00:00:00 2001 From: MiraMaX166 Date: Mon, 20 Mar 2023 12:30:25 +0600 Subject: [PATCH] fix readme in project ubl-settings-datetime --- ubl-settings-datetime/README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/ubl-settings-datetime/README.md b/ubl-settings-datetime/README.md index 67a0819..79537e0 100644 --- a/ubl-settings-datetime/README.md +++ b/ubl-settings-datetime/README.md @@ -21,7 +21,7 @@ 1. **ТЕХНОЛОГИЧЕСКИЕ ТРЕБОВАНИЯ:** 1. Приложение разрабатывается под нужды операционной системы UBLinux 1. Использование фирменного логотипа компании - 1. Название приложения, техническое: **ubl-settings-datetime** (далее **${NAME_APPLICATION}**) + 1. Название приложения, техническое: **ubl-settings-datetime** (далее **\${NAME_APPLICATION}**) 1. Название приложения, публичное: **Дата и время** 1. Стек технологий: 1. Язык программирования: Bash или C(++) @@ -30,26 +30,26 @@ 1. Операционная система разработки: UBLinux DB 1. Структура: 1. Bash/C(++): Весь функционал сосредоточен в графической части, вызовы и исполнение процедур написаны на языках Bash, C(++) -**/usr/bin/${NAME_APPLICATION} (скомпилированный бинарный файл)** +**/usr/bin/\${NAME_APPLICATION} (скомпилированный бинарный файл)** 1. Графическая часть, фронт **/usr/share/\${NAME_APPLICATION}/ui/\${NAME_APPLICATION}.glade** 1. Стили виджетов GTK **/usr/share/\${NAME_APPLICATION}/css/\${NAME_APPLICATION}.css** 1. Элементы изображений 1. Иконки: -**/usr/share/icons/hicolor/scalable/apps/${NAME_APPLICATION}{\*.png,\*.svg}** +**/usr/share/icons/hicolor/scalable/apps/\${NAME_APPLICATION}{\*.png,\*.svg}** Файлы изображений png иконок должны иметь имена вида: - ru.ublinux.\${NAME_APPLICATION}.svg - ru.ublinux.\${NAME_APPLICATION}.\${NAME_ICONS}.svg -Где ${NAME_ICONS} - имя графического элемента, например: checked, warning, alert и т.д. +Где \${NAME_ICONS} - имя графического элемента, например: checked, warning, alert и т.д. Файлы изображений png иконок должны генерироваться из svg файла в размеры 16, 32, 48, 64 пикселей сценарием make-файла. 1. Изображения: **/usr/share/\${NAME_APPLICATION}/ui/{\*.png,\*.svg}** 1. Локализация En/Ru -Для локализации должен быть создан файл-шаблон ***${NAME_APPLICATION}.pot***, на его основе должны быть созданы сами ***po-файлы*** переводов на необходимые языки, через файл сборки из po-файлов компилируются ***mo-файлы*** и размещаются сценарием установки по указанному пути: +Для локализации должен быть создан файл-шаблон ***\${NAME_APPLICATION}.pot***, на его основе должны быть созданы сами ***po-файлы*** переводов на необходимые языки, через файл сборки из po-файлов компилируются ***mo-файлы*** и размещаются сценарием установки по указанному пути: **/usr/share/locale/\${LANG}/LC_MESSAGES/\${FILE_MO}** -где ${LANG} - каталог с именем локали, например, "ru" или "ru_RU", -\${FILE_MO} - файл локализации программы, например, "${NAME_APPLICATION}.mo" +где \${LANG} - каталог с именем локали, например, "ru" или "ru_RU", +\${FILE_MO} - файл локализации программы, например, "\${NAME_APPLICATION}.mo" 1. Версия ПО 1. Файл, в котором хранится версия - VERSION.md, находится в корне каталога проекта. 1. При компиляции (через сценарий make-файла) данные из файла VERSION.md передаются в значение переменной (-ых) version_application в файлах-исходниках ПО. @@ -107,9 +107,9 @@ 1. Кнопка с иконкой с выпадающим списком -> “Справка, О приложении” 1. Справка - запуск браузера с переходом на ссылку: 1. локализованный (ru_RU) вариант: -https://wiki.ublinux.ru/ru/Программное_обеспечение/Программы_и_утилиты/Все/${NAME_APPLICATION} (далее ${URLWIKI}) +https://wiki.ublinux.ru/ru/Программное_обеспечение/Программы_и_утилиты/Все/\${NAME_APPLICATION} (далее \${URLWIKI}) 1. локализованный (en_EN) вариант: -https://wiki.ublinux.com/ru/Программное_обеспечение/Программы_и_утилиты/Все/${NAME_APPLICATION} (далее ${URLWIKI}) +https://wiki.ublinux.com/ru/Программное_обеспечение/Программы_и_утилиты/Все/\${NAME_APPLICATION} (далее \${URLWIKI}) 1. О приложении. Открывается диалоговое окно с выводом информации о программе: 1. Заголовок окна по локализованному названию утилиты 1. Копирайты, порядок: @@ -118,9 +118,9 @@ https://wiki.ublinux.com/ru/Программное_обеспечение/Про 1. Версия программы (переменная version_application) 1. Название утилиты, локализованное 1. Ссылка "Домашняя страница проекта" на https://ublinux.ru/ - 1. Авторские права © ООО "Юбисофт", 2022 - $LASTYEAR - - локализованный (en_EN) вариант: "Copyright © UBSoft LLC, 2022 - $LASTYEAR" - - где $LASTYEAR - текущий год. + 1. Авторские права © ООО "Юбисофт", 2022 - \$LASTYEAR + - локализованный (en_EN) вариант: "Copyright © UBSoft LLC, 2022 - \$LASTYEAR" + - где \$LASTYEAR - текущий год. 1. Обработчик ошибок. Встроенный небольшой обработчик кодов внутренних ошибок, который должен передавать статус возникшей ошибки в строку уведомления. Например: "Невозможно прочитать значение параметра XXXXXX!" 1. Строка уведомлений. Цвет в зависимости от сигнала: - песочный, пиктограмма "Птичка", сообщения об удачных загрузках или сохранениях конфигураций системы. @@ -128,7 +128,7 @@ https://wiki.ublinux.com/ru/Программное_обеспечение/Про 1. **КОМАНДЫ** 1. Справка, О приложении > Домашняя страница проекта: -xdg-open ${URLWIKI} & +xdg-open \${URLWIKI} & 1. Текущие дата и время 1. Чтение значения: 1. через средства функции на языке С(++) @@ -182,14 +182,14 @@ xdg-open ${URLWIKI} & 1. **ПОМОЩЬ И ПАРАМЕТРЫ ЗАПУСКА** 1. Помощь - Пример вывода: - > ubl-settings-datetime version: $VERSION + > ubl-settings-datetime version: \$VERSION > GTK settings datetime for UBLinux > > Использование: ubl-settings-datetime [OPTIONS...] > Параметры приложения: - > $OPTIONS + > \$OPTIONS - Где $OPTIONS - параметры запуска, $VERSION - версия программы (переменная version_application). + Где \$OPTIONS - параметры запуска, \$VERSION - версия программы (переменная version_application). 1. Параметры запуска: 1. *-h, --help* - Показать параметры справки