update and fix readme in project ubl-settings-bootloader

pull/20/head
MiraMaX166 3 years ago
parent 16da96658c
commit c597e6f621
Signed by: user-166
GPG Key ID: C58520EF14C48E3A

@ -21,7 +21,7 @@
1. **ТЕХНОЛОГИЧЕСКИЕ ТРЕБОВАНИЯ:**
1. Приложение разрабатывается под нужды операционной системы UBLinux
1. Использование фирменного логотипа компании
1. Название приложения, техническое: **ubl-settings-bootloader** (далее **${NAME_APPLICATION}**)
1. Название приложения, техническое: **ubl-settings-bootloader** (далее **\${NAME_APPLICATION}**)
1. Название приложения, публичное: **Загрузка системы**
1. Стек технологий:
1. Язык программирования: Bash или C(++)
@ -30,32 +30,35 @@
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. Файл с перечнем и описанием параметров передаваемых ядру
**/usr/share/ubl-sttings-bootloadr/boot-options.csv**
1. Файл с перечнем и описанием параметров терминала для ввода
**/usr/share/ubl-sttings-bootloadr/input-options.csv**
1. Файл с перечнем и описанием параметров терминала для вывода
**/usr/share/ubl-sttings-bootloadr/output-options.csv**
1. Версия ПО
1. Файл, в котором хранится версия - VERSION.md, находится в корне каталога проекта.
1. При компиляции (через сценарий make-файла) данные из файла VERSION.md передаются в значение переменной (-ых) version_application в файлах-исходниках ПО.
1. **ТЕХНИЧЕСКОЕ ЗАДАНИЕ:**
1. Ярлык (desktop-файл):
@ -128,20 +131,20 @@
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. Копирайты, порядок:
1. Иконка приложения
1. Название утилиты
1. Версия программы
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. Строка уведомлений. Цвет в зависимости от сигнала:
- песочный, пиктограмма "Птичка", сообщения об удачных загрузках или сохранениях конфигураций системы.
@ -156,7 +159,7 @@ https://wiki.ublinux.com/ru/Программное_обеспечение/Про
1. **КОМАНДЫ**
1. Справка, О приложении > Домашняя страница проекта:
xdg-open ${URLWIKI} &
xdg-open \${URLWIKI} &
1. Меню загрузки
1. Таймер выбора варианта загрузки:
1. Чтение значения:
@ -165,7 +168,7 @@ xdg-open ${URLWIKI} &
1. Установить значение:
1. в локальный конфигурационный файл: `/usr/bin/ubconfig --target system set config XXXXXX=$VALUE`
1. в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set config XXXXXX=$VALUE`
где $VALUE - параметр, цифровой, от 1 до 60.
где \$VALUE - параметр, цифровой, от 1 до 60.
1. Загрузка по умолчанию:
1. Должен быть получен список ОС и вариантов загрузки.
1. Последний выбор станет выбором загрузки по умолчанию:
@ -175,7 +178,7 @@ xdg-open ${URLWIKI} &
1. Установить значение:
1. в локальный конфигурационный файл: `/usr/bin/ubconfig --target system set config XXXXXX=$VALUE`
1. в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set config XXXXXX=$VALUE`
где $VALUE - параметр, цифровой, 1 или 0. Указывает на включение или отключение данной опции.
где \$VALUE - параметр, цифровой, 1 или 0. Указывает на включение или отключение данной опции.
1. Параметры, передаваемые ядру
1. через функции фронтенда передавать выбранный параметр в поле "Параметры командной строки" блока "Параметры, передаваемые ядру"
1. Параметры командной строки:
@ -185,7 +188,7 @@ xdg-open ${URLWIKI} &
1. Установить значение:
1. в локальный конфигурационный файл: `/usr/bin/ubconfig --target system set config CMDLINE=$VALUE`
1. в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set config CMDLINE=$VALUE`
где $VALUE - перечень параметров, полученных исходя из выбранных опций в блоке "Параметры, передаваемые ядру", разделённых пробелом.
где \$VALUE - перечень параметров, полученных исходя из выбранных опций в блоке "Параметры, передаваемые ядру", разделённых пробелом.
1. Терминал для ввода
1. через функции фронтенда передавать выбранный параметр в поле "Параметры командной строки" блока "Терминал для ввода"
1. Параметры командной строки:
@ -195,7 +198,7 @@ xdg-open ${URLWIKI} &
1. Установить значение:
1. в локальный конфигурационный файл: `/usr/bin/ubconfig --target system set config XXXXXX=$VALUE`
1. в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set config XXXXXX=$VALUE`
где $VALUE - перечень параметров, полученных исходя из выбранных опций в блоке "Терминал для ввода", разделённых пробелом.
где \$VALUE - перечень параметров, полученных исходя из выбранных опций в блоке "Терминал для ввода", разделённых пробелом.
1. Терминал для вывода
1. через функции фронтенда передавать выбранный параметр в поле "Параметры командной строки" блока "Терминал для вывода"
1. Параметры командной строки:
@ -205,7 +208,7 @@ xdg-open ${URLWIKI} &
1. Установить значение:
1. в локальный конфигурационный файл: `/usr/bin/ubconfig --target system set config XXXXXX=$VALUE`
1. в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set config XXXXXX=$VALUE`
где $VALUE - перечень параметров, полученных исходя из выбранных опций в блоке "Терминал для вывода", разделённых пробелом.
где \$VALUE - перечень параметров, полученных исходя из выбранных опций в блоке "Терминал для вывода", разделённых пробелом.
1. **ПРИБЛИЗИТЕЛЬНЫЙ МАКЕТ ПРИЛОЖЕНИЯ.**
1. Главное окно

Loading…
Cancel
Save