3 releases (breaking)
new 0.3.0 | Oct 23, 2024 |
---|---|
0.2.0 | Oct 20, 2024 |
0.1.0 | Oct 20, 2024 |
#199 in Command line utilities
412 downloads per month
215KB
494 lines
Helper [WIP - 1.0.0 coming soon]
[WIP] Helper - интерактивная консольная программа, содержащая инструкции по использованию различных команд операционных систем семейства UNIX (на данный момент Helper собирается только для Linux, однако возможно портирование и на другие Unix'ы, например на FreeBSD).
Структура проекта
src/
- исходный код программы (Rust);res/
- ресурсы программы (файлы документации, отображаемые в программе);
Сборка
Зависимости
rustc
,cargo
,gcc
ncurses
,glibc
Локальная сборка
cargo build --release
sudo mkdir -pv /usr/share/helper
sudo cp -rv ./res/* /usr/share/helper/
sudo cp -v ./target/release/helper /usr/bin/
Запуск
Запуск локальной версии из репозитория
cargo run
Запуск версии для установки
cargo run --no-default-features --features="system-files"
В таком случае будут использованы файлы ресурсов (справочные файлы и файл со структурой главного меню), установленные в систему.
Справочная система
Программа читает ряд файлов, установленных в /usr/share/helper/<CATEGORY>/<FILE>
, где <CATEGORY>
- имя категории (информация о дистрибутивах, информация о пакетных менеджерах, информация об офисных пакетах, quick fix'ы и т.п.).
Система меню
Меню формируется автоматически на базе содержимого файла /usr/share/helper/documentation.toml
.
Планы на дальнейшую разработку проекта
- Сборка бинарных пакетов для различных дистрибутивов Linux;
- Портирование на более редкие Unix-ОС. Например, на FreeBSD;
- Создание простого парсера Markdown для более красивого отображения инструкций в консоли;
- Реализация поиска по справке;
Dependencies
~7–14MB
~159K SLoC