From 3c7d92a08a07fb2ae1c010ab55ec28011e746af4 Mon Sep 17 00:00:00 2001 From: MiraMaX166 Date: Wed, 15 Mar 2023 18:09:36 +0600 Subject: [PATCH] update readme in project ubl-settings-info --- ubl-settings-info/README.md | 50 ++++++++++++++++++++++++------------- 1 file changed, 33 insertions(+), 17 deletions(-) diff --git a/ubl-settings-info/README.md b/ubl-settings-info/README.md index 7afc66f..b61299b 100644 --- a/ubl-settings-info/README.md +++ b/ubl-settings-info/README.md @@ -21,7 +21,7 @@ 1. **ТЕХНОЛОГИЧЕСКИЕ ТРЕБОВАНИЯ:** 1. Приложение разрабатывается под нужды операционной системы UBLinux 1. Использование фирменного логотипа компании - 1. Название приложения, техническое: **ubl-settings-info** + 1. Название приложения, техническое: **ubl-settings-info** (далее **${NAME_APPLICATION}**) 1. Название приложения, публичное: **Информация о системе** 1. Стек технологий: 1. Язык программирования: Bash или C(++) @@ -30,16 +30,24 @@ 1. Операционная система разработки: UBLinux DB 1. Структура: 1. Bash/C(++): Весь функционал сосредоточен в графической части, вызовы и исполнение процедур написаны на языках Bash, C(++) -**/usr/bin/ubl-settings-info (скомпилированный бинарный файл)** +**/usr/bin/${NAME_APPLICATION} (скомпилированный бинарный файл)** 1. Графическая часть, фронт -Файл **glade** скомпилирован в бинарный файл +**/usr/share/\${NAME_APPLICATION}/ui/\${NAME_APPLICATION}.glade** 1. Стили виджетов GTK -Файл **css** скомпилирован в бинарный файл +**/usr/share/\${NAME_APPLICATION}/css/\${NAME_APPLICATION}.css** 1. Элементы изображений -**/usr/share/ubl-settings-info/images/{\*.png,\*.svg}** + 1. Иконки: +**/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 и т.д. + Файлы изображений png иконок должны генерироваться из svg файла в размеры 16, 32, 48, 64 пикселей сценарием make-файла. + 1. Изображения: +**/usr/share/\${NAME_APPLICATION}/ui/{\*.png,\*.svg}** 1. Локализация En/Ru -Для локализации должен быть создан файл-шаблон ***name_programm.pot***, на его основе должны быть созданы сами ***po-файлы*** переводов на необходимые языки, через файл сборки из po-файлов компилируются ***mo-файлы*** и размещаются сценарием установки по указанному пути: -**/usr/share/locale/\${LANG}/LC_MESSAGES/${FILE_MO}** +Для локализации должен быть создан файл-шаблон ***${NAME_APPLICATION}.pot***, на его основе должны быть созданы сами ***po-файлы*** переводов на необходимые языки, через файл сборки из po-файлов компилируются ***mo-файлы*** и размещаются сценарием установки по указанному пути: +**/usr/share/locale/\${LANG}/LC_MESSAGES/\${FILE_MO}** где ${LANG} - каталог с именем локали, например, "ru" или "ru_RU", \${FILE_MO} - файл локализации программы, например, "${NAME_APPLICATION}.mo" @@ -86,19 +94,27 @@ 1. Информация об ОЗУ, например, *Оперативная память: 4406MiB / 15934MiB*. 1. **ОСОБЕННОСТИ** - 1. Окно с выводом информации о программе: + 1. Кнопка с иконкой с выпадающим списком -> “Справка, О приложении” + 1. Справка - запуск браузера с переходом на ссылку: + 1. локализованный (ru_RU) вариант: +https://wiki.ublinux.ru/ru/Программное_обеспечение/Программы_и_утилиты/Все/${NAME_APPLICATION} (далее ${URLWIKI}) + 1. локализованный (en_EN) вариант: +https://wiki.ublinux.com/ru/Программное_обеспечение/Программы_и_утилиты/Все/${NAME_APPLICATION} (далее ${URLWIKI}) + 1. О приложении. Открывается диалоговое окно с выводом информации о программе: 1. Заголовок окна по локализованному названию утилиты - 1. Копирайты, порядок: - 1. Иконка приложения - 1. Название утилиты - 1. Версия программы - 1. Название утилиты, локализованное - 1. Ссылка "Домашняя страница проекта" на https://ublinux.ru/ - 1. Авторские права © ООО "Юбисофт", 2022 - $LASTYEAR - - локализованный (en_EN) вариант: "Copyright © UBSoft LLC, 2022 - $LASTYEAR" - - где $LASTYEAR - текущий год. + 1. Копирайты, порядок: + 1. Иконка приложения + 1. Название утилиты + 1. Версия программы + 1. Название утилиты, локализованное + 1. Ссылка "Домашняя страница проекта" на https://ublinux.ru/ + 1. Авторские права © ООО "Юбисофт", 2022 - $LASTYEAR + - локализованный (en_EN) вариант: "Copyright © UBSoft LLC, 2022 - $LASTYEAR" + - где $LASTYEAR - текущий год. 1. **КОМАНДЫ** + 1. Справка, О приложении > Домашняя страница проекта: +xdg-open ${URLWIKI} & 1. Получить имя текущего пользователя 1. команда - `` 1. Получить имя хоста