add readme

This commit is contained in:
Your Name 2026-01-09 04:18:00 +03:00
parent cc0179ca6c
commit 4ff5eea299
6 changed files with 44 additions and 20 deletions

2
.gitignore vendored
View File

@ -6,6 +6,8 @@ config/SSL/privkey.pem
logs/ logs/
SECRET_KEY.key SECRET_KEY.key
car_ui.spec car_ui.spec
dev_mode_enable
reset
repository/achievement_repository.py repository/achievement_repository.py
service/achievement_service.py service/achievement_service.py

View File

@ -1,20 +0,0 @@
QWidget {
background-color: #0b0b0b;
}
QPushButton {
background-color: #1a1a1a;
color: white;
font-size: 28px;
border-radius: 16px;
}
QPushButton:pressed {
background-color: #1e90ff;
}
QPushButton#SettingsRow QLabel#SettingsRowTitle,
QPushButton#SettingsRow QLabel#SettingsRowSub,
QPushButton#SettingsRow QLabel#SettingsChevron {
background: transparent;
}

42
README.md Normal file
View File

@ -0,0 +1,42 @@
# car_ui
Интерфейс магнитолы для Raspberry Pi (PySide6), экран 1024x600.
## Требования
- Python 3.13.5
## Как запускать
Право на запуск:
```bash
chmod +x setup_venv.sh run_ui.sh build_app.sh
```
Запуск:
```bash
./setup_venv.sh
./run_ui.sh
./build_app.sh
```
## Скрипты
- `setup_venv.sh` — создает виртуальное окружение `.venv` и устанавливает зависимости из `requirements.txt`.
- `run_ui.sh` — запускает UI локально, выставляя `DISPLAY=:0` и выполняя `main.py`.
- `build_app.sh` — собирает приложение через PyInstaller в `dist/` (имя `car_ui`).
## Конфиг
Файл конфигурации UI находится здесь: `~/.config/car_ui/ui.conf`.
## Файлы-маркеры в корне
В корне проекта могут находиться специальные файлы-маркеры:
- `reset` — сигнал сброса до заводских настроек.
- `dev_mode_enable` — сигнал включения режима разработчика.
Если нужен соответствующий режим, создайте пустой файл с нужным именем; удалите файл, чтобы отключить режим.

0
build_app.sh Normal file → Executable file
View File

0
run_ui.sh Normal file → Executable file
View File

0
setup_venv.sh Normal file → Executable file
View File