From 10bfa8811cd340d81ed6528079334a5c3aacfce3 Mon Sep 17 00:00:00 2001 From: MiraMaX166 Date: Fri, 10 Mar 2023 12:08:40 +0600 Subject: [PATCH] fix readme in project ubl-settings-bootloader --- ubl-settings-bootloader/README.md | 62 +++++++++++++++++++++---------- 1 file changed, 42 insertions(+), 20 deletions(-) diff --git a/ubl-settings-bootloader/README.md b/ubl-settings-bootloader/README.md index 43e5928..415f636 100644 --- a/ubl-settings-bootloader/README.md +++ b/ubl-settings-bootloader/README.md @@ -10,10 +10,10 @@ 1. N дней - разработка приложения 1. N дня - тестирование приложения и исправление ошибок 1. Перечень этапов разработки приложения: - 1. Разработка макета и дизайна приложения, самостоятельно - 1. Утверждение и доработка макета, самостоятельно - 1. Создание работающего интерфейса, включая полную разработку действующих ярлыков, кнопок и т.д., самостоятельно - 1. Проектирование алгоритма работы приложения, самостоятельно + 1. Разработка макета и дизайна приложения + 1. Утверждение и доработка макета + 1. Создание работающего интерфейса, включая полную разработку действующих ярлыков, кнопок и т.д. + 1. Проектирование алгоритма работы приложения 1. Написание работающего кода приложения, включая полноценно работающие элементы графического интерфейса, а также перевод (поддержка локализации En, Ru), самостоятельно 1. Тестирование и исправление ошибок, самостоятельно 1. Публикация @@ -24,23 +24,25 @@ 1. Название приложения, техническое: **ubl-settings-bootloader** 1. Название приложения, публичное: **Загрузка системы** 1. Стек технологий: - 1. Язык программирования: Bash или C++ + 1. Язык программирования: Bash или C(++) 1. Приложение для разработки графического интерфейса: Glade 3 1. Графические библиотеки: GTK3 1. Операционная система разработки: UBLinux DB 1. Структура: - 1. **/usr/bin/ubl-settings-bootloader (скомпилированный бинарный файл)** -Bash/C: Весь функционал сосредоточен в графической части, вызовы и исполнение процедур написаны на языках Bash, C++ - 1. Файл **glade** скомпилирован в бинарный файл -Графическая часть, фронт - 1. Файл **css** скомпилирован в бинарный файл -Стили виджетов GTK - 1. **/usr/share/ubl-settings-bootloader/images/{\*.png,\*.svg}** -Элементы изображений - 1. **/usr/share/ubl-settings-bootloader/locale -> /usr/share/locale** -Локализация En/Ru - 1. **/usr/share/ubl-sttings-bootloadr/list_bootoptions.csv** -Файл с перечнем и описанием параметров ядра и загрузчика + 1. Bash/C(++): Весь функционал сосредоточен в графической части, вызовы и исполнение процедур написаны на языках Bash, C(++) +**/usr/bin/ubl-settings-bootloader (скомпилированный бинарный файл)** + 1. Графическая часть, фронт +Файл **glade** скомпилирован в бинарный файл + 1. Стили виджетов GTK +Файл **css** скомпилирован в бинарный файл + 1. Элементы изображений +**/usr/share/ubl-settings-bootloader/images/{\*.png,\*.svg}** + 1. Локализация En/Ru +**/usr/share/locale/\${LANG}/LC_MESSAGES/${FILE_MO}** +где ${LANG} - каталог с именем локали, например, "ru" или "ru_RU", +${FILE_MO} - файл локализации программы, например, "name_programm.mo" + 1. Файл с перечнем и описанием параметров ядра и загрузчика +**/usr/share/ubl-sttings-bootloadr/bootoptions.csv** 1. **ТЕХНИЧЕСКОЕ ЗАДАНИЕ:** 1. Ярлык (desktop-файл): @@ -58,7 +60,7 @@ Bash/C: Весь функционал сосредоточен в графиче 1. Иконка приложения. Статический элемент. Выравнивание по левому краю. 1. Кнопка с выпадающим списком "Загрузить" -> ("Загрузить глобальную конфигурацию, Загрузить локальную конфигурацию"). Статический элемент. Выравнивание по левому краю. 1. Заголовок окна, название приложения. Выравнивание по центру между элементами. - 1. Кнопка с выпадающим списком "Сохранить" -> ("Сохранить глобальную конфигурацию, Сохранить локальную конфигурацию"). Статический элемент. Выравнивание по правому краю. + 1. Кнопка с выпадающим списком "Сохранить" -> ("Сохранить в глобальную и локальную конфигурацию, Сохранить глобальную конфигурацию, Сохранить локальную конфигурацию"). Статический элемент. Выравнивание по правому краю. 1. Кнопка с иконкой с выпадающим списком -> "Справка, О приложении". Статический элемент. Выравнивание по правому краю. 1. Стандартные элементы окна, кнопки "Свернуть, Минимизировать/На весь экран, Закрыть" 1. В верхней части крупный логотип утилиты, с права от него краткое описание утилиты. Фон заполнен изображением. Статические элементы. Выравнивание по левому краю. @@ -105,8 +107,28 @@ Bash/C: Весь функционал сосредоточен в графиче 1. поле ввода с лэйблом "Параметры командной строки:". Динамический элемент. От края до края родительского элемента по горизонтали. 1. **ОСОБЕННОСТИ** - 1. Поля "Параметры командной строки" заполняются автоматически при выборе необходимых параметров, разделение через пробел. - 1. При удалении параметра из + 1. При загрузке утилиты по умолчанию загружаются данные из локального конфигурационного файла (выполняются команды блоков "Чтение значений: из локального конфигурационного файла"). + 1. Функции записи в локальный конфигурационный файл и чтения-записи в глобальный конфигурационный файл должны проходить процедуру повышения привилегий прав пользователя через polkit. + 1. Кнопка "Загрузить" -> ("Загрузить глобальную конфигурацию, Загрузить локальную конфигурацию"). При нажатии на кнопку происходит открытие меню с пунктами: "Загрузить глобальную конфигурацию, Загрузить локальную конфигурацию". Загрузка текущей и глобальной конфигурации в системе через скрипт ubconfig (выполняются команды блоков "Чтение значений: из локального конфигурационного файла"), загрузка конфигурации из файла настроек ОС ublinux.ini (выполняются команды блоков "Чтение значений: из глобального конфигурационного файла"). + 1. Кнопка "Сохранить" -> ("Сохранить в глобальную и локальную конфигурацию). Сохраняет текущие настройки через скрипт ubconfig (выполняются команды блоков "Установить значение: в локальный конфигурационный файл") и в конфигурационный файл настроек ОС ublinux.ini (выполняются команды блоков "Установить значение: в глобальный конфигурационный файл"). При выборе пунктов "Сохранить в глобальную конфигурацию, Сохранить в локальную конфигурацию" происходит отдельное сохранение настроек. + 1. Обработчик ошибок. Встроенный небольшой обработчик кодов внутренних ошибок, который должен передавать статус возникшей ошибки в строку уведомления. Например: "Невозможно прочитать значение параметра XXXXXX!" + 1. Строка уведомлений. Цвет в зависимости от сигнала: + - песочный, пиктограмма "Птичка", сообщения об удачных загрузках или сохранениях конфигураций системы. + - красный, пиктограмма "Восклицательный знак", сообщения об ошибках при сохранении, загрузке параметров конфигурации, при ошибках в работе программы, полученных от обработчика ошибок. + 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. Значения параметров ядра и загрузчика берутся из файла /usr/share/ubl-sttings-bootloadr/list_bootoptions.csv 1. Английские слова в файл проекта ubl-sttings-bootloadr.pot Перевод в файле локализации проекта ubl-sttings-bootloadr_ru.po