From 01c6b9cb29d6afb136632870ee2c34b97332ba0e Mon Sep 17 00:00:00 2001 From: Yuriy Date: Thu, 29 Jan 2026 16:40:18 +0300 Subject: [PATCH] docs: add README with CI badge and Release process --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..70c8fb5 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# PAPA YU + +[![CI](https://github.com/yrippert-maker/papayu/actions/workflows/ci.yml/badge.svg)](https://github.com/yrippert-maker/papayu/actions/workflows/ci.yml) + +Десктопное приложение (Tauri 2 + React). + +--- + +## Сборка и запуск + +- **Разработка:** из корня репозитория: `cd desktop/src-tauri && cargo tauri dev` (или из `desktop/ui` — `npm run dev`, отдельно backend по необходимости). +- **Сборка:** `cd desktop/src-tauri && cargo tauri build`. +- Подробнее: [docs/РЕЛИЗ_И_ОБНОВЛЕНИЯ.md](docs/РЕЛИЗ_И_ОБНОВЛЕНИЯ.md). + +--- + +## Release process + +- Релизы собираются в GitHub Actions по тегам `v*` (workflow **Release**). +- Чеклист выпуска релиза и проверки обновлений: [docs/РЕЛИЗ_И_ОБНОВЛЕНИЯ.md](docs/РЕЛИЗ_И_ОБНОВЛЕНИЯ.md). +- Если сборка падает: [docs/CI_ОТЛАДКА_РЕЛИЗА.md](docs/CI_ОТЛАДКА_РЕЛИЗА.md) — классификация ошибок и точечные патчи. + +--- + +## Документация + +| Документ | Описание | +|----------|----------| +| [docs/РЕЛИЗ_И_ОБНОВЛЕНИЯ.md](docs/РЕЛИЗ_И_ОБНОВЛЕНИЯ.md) | Релиз, теги, секреты, проверка обновлений | +| [docs/CI_ОТЛАДКА_РЕЛИЗА.md](docs/CI_ОТЛАДКА_РЕЛИЗА.md) | Отладка падений `tauri build` в CI | +| [docs/SSH_НАСТРОЙКА.md](docs/SSH_НАСТРОЙКА.md) | Настройка SSH для GitHub | +| [docs/CONTRACTS.md](docs/CONTRACTS.md) | Контракты и архитектура |