BreakoutGuard AI

RU
Быстрый старт
1. Установите приложение или распакуйте bundle.
2. Откройте `.env` и заполните ключи Binance и Telegram.
3. Запустите `BreakoutGuardLauncher`.
4. Проверьте лицензию и подключения во вкладке `Overview`.
5. При необходимости загрузите или отредактируйте `config.yaml`, затем сохраните изменения.

Где лежат пользовательские файлы
- Windows: `%LOCALAPPDATA%\BreakoutGuardAI`
- Linux: `~/.local/share/BreakoutGuardAI`

Ключевые файлы и папки
- `.env`
- `config.yaml`
- `bot_logs/`
- `launcher_logs/`
- `data/`
- `trade_history/`
- `trade_charts/`
- `backtest_logs/`

Запуск через launcher
- `Start bot` запускает рабочий процесс бота.
- `Stop bot` корректно останавливает процесс.
- `Load config` загружает внешний конфиг в launcher.
- `Save config` сохраняет текущие изменения в рабочий `config.yaml`.
- Launcher автоматически делает резервную копию конфига перед сохранением.

Linux bundle
- Дайте права на запуск: `chmod +x install.sh BreakoutGuardLauncher BreakoutGuardBot`
- Установите локально: `./install.sh`
- После установки launcher лежит в `~/.local/opt/BreakoutGuardAI/BreakoutGuardLauncher`
- Бот лежит в `~/.local/opt/BreakoutGuardAI/BreakoutGuardBot`
- Без установки launcher можно запустить прямо из распакованной папки: `./BreakoutGuardLauncher`

EN
Quick start
1. Install the application or unpack the bundle.
2. Open `.env` and fill in your Binance and Telegram keys.
3. Launch `BreakoutGuardLauncher`.
4. Check license and connectivity on the `Overview` tab.
5. If needed, load or edit `config.yaml`, then save changes.

Where user files are stored
- Windows: `%LOCALAPPDATA%\BreakoutGuardAI`
- Linux: `~/.local/share/BreakoutGuardAI`

Key files and folders
- `.env`
- `config.yaml`
- `bot_logs/`
- `launcher_logs/`
- `data/`
- `trade_history/`
- `trade_charts/`
- `backtest_logs/`

Launcher workflow
- `Start bot` starts the trading bot process.
- `Stop bot` stops it gracefully.
- `Load config` loads an external config into the launcher.
- `Save config` writes current edits into the working `config.yaml`.
- The launcher automatically creates a config backup before saving.

Linux bundle
- Make the binaries executable: `chmod +x install.sh BreakoutGuardLauncher BreakoutGuardBot`
- Install locally: `./install.sh`
- After installation the launcher is available at `~/.local/opt/BreakoutGuardAI/BreakoutGuardLauncher`
- The bot binary is available at `~/.local/opt/BreakoutGuardAI/BreakoutGuardBot`
- Without installing you can run the launcher directly from the unpacked folder: `./BreakoutGuardLauncher`
