docs: Add quick start guide for Windows Portable

This commit is contained in:
Umbrix Developer
2026-01-20 13:30:04 +03:00
parent b628bfcd82
commit dec7ed2509

View File

@@ -0,0 +1,87 @@
# 🚀 Быстрая сборка Windows Portable ZIP
## Проблема решена! ✅
Теперь в ZIP будут файлы которые помогут пользователям не запутаться:
```
umbrix-portable/
├── 📄 README.txt ⭐ ПЕРВЫЙ в списке - ясная инструкция!
├── 🚀 Запустить Umbrix.bat ⭐ Удобный запуск одним кликом
├── 📱 Umbrix.exe ⭐ Основное приложение
├── ⚙️ UmbrixCli.exe ⚠️ Служебная утилита
└── ...DLL и папки...
```
---
## 📦 Команда для сборки на Windows
```powershell
# 1. Собрать Release
flutter build windows --release
# 2. Скопировать файлы для пользователей + создать ZIP
$buildPath = "build\windows\x64\runner\Release"
Copy-Item "windows\packaging\portable\README.txt" -Destination "$buildPath\" -Force
Copy-Item "windows\packaging\portable\Запустить Umbrix.bat" -Destination "$buildPath\" -Force
$zipName = "umbrix-1.7.5-portable-windows-x64.zip"
Compress-Archive -Path "$buildPath\*" -DestinationPath $zipName -Force
# 3. Проверить
Get-Item $zipName | Select-Object Name, @{N="MB";E={[math]::Round($_.Length/1MB,2)}}
```
---
## ✅ Что увидит пользователь после распаковки
1. **README.txt** - первый файл (по алфавиту с символом '═')
- Большой заголовок с инструкцией
- Указывает запускать **Umbrix.exe**
- Предупреждает не запускать UmbrixCli.exe
2. **Запустить Umbrix.bat** - второй файл
- Русское название понятное всем
- Запускает Umbrix.exe автоматически
3. **Umbrix.exe** - основное приложение
- Яркая цветная иконка
- Выделяется визуально
4. **UmbrixCli.exe** - служебная утилита
- Название "Cli" намекает что это командная строка
- Большинство не будет трогать
---
## 🎯 Альтернативы (если не понравится)
### Вариант 1: Скрыть CLI в подпапку
```powershell
# При создании ZIP переместить CLI в tools/
New-Item -Path "$buildPath\tools" -ItemType Directory -Force
Move-Item "$buildPath\UmbrixCli.exe" "$buildPath\tools\" -Force
Compress-Archive -Path "$buildPath\*" -DestinationPath $zipName -Force
```
### Вариант 2: Переименовать основное приложение
Изменить в `windows/packaging/exe/make_config.yaml`:
```yaml
executable_name: Start-Umbrix.exe # Без пробела!
```
⚠️ Но это сломает update скрипты которые ищут `umbrix.exe`
### Вариант 3: Только батник
Удалить README.txt, оставить только `Запустить Umbrix.bat` как единственный понятный способ запуска.
---
## 📝 Полная документация
См. [WINDOWS_PORTABLE_ZIP.md](./WINDOWS_PORTABLE_ZIP.md) для:
- Создания релиза в Gitea
- Загрузки ZIP через API
- Тестирования auto-update
- Сравнения ZIP vs EXE