Update README.md

easydev991 · web-flow · commit 970aa5d78ce1 · 2025-03-15T12:51:48.000+03:00
diff --git a/README.md b/README.md
@@ -1,101 +1,6 @@
 # SW Площадки
 [Ссылка на приложение в AppStore](https://workout.su/ios)
 
-## Установка и настройка проекта
-1. Клонировать репозиторий
-2. В терминале перейти в папку с проектом 
-```shell
-cd SwiftUI-WorkoutApp
-```
-3. Настроить адрес папки с хуками `SwiftUI-WorkoutApp/githooks`
-```shell
-git -C /*путь_к_репозиторию*/ config core.hooksPath ./githooks
-```
-4. Дать разрешение на запуск хука `pre-push`
-```shell
-chmod +x SwiftUI-WorkoutApp/githooks/pre-push
-```
-5. Открыть проект в `Xcode` и дождаться загрузки зависимостей
-6. Проект готов к работе!
-
-## Помощь проекту
-1. Для доработок создаем **issue** с описанием задачи
-2. Доработки делаем в отдельных ветках
-3. Для каждого **PR** необходимо оставить описание на русском языке по аналогии со старыми **PR**
-4. Вопросы по iOS-приложению решаем с Oleg991 в [почте](mailto:o.n.eremenko@gmail.com?subject=[GitHub]-SwiftUI-WorkoutApp), [телеграм](http://t.me/oleg991) или в **issue** с подробным описанием проблемы
-5. Вопросы по бэкенду/сайту - c Антоном в [почте](mailto:anton@workout.su?subject=[GitHub]-SwiftUI-WorkoutApp) или в **issue** с подробным описанием проблемы
-
-## Шпаргалка
-### Настройка базовых параметров приложения  
-`Xcode -> SwiftUI-WorkoutApp -> Target: SwiftUI-WorkoutApp -> General`
-- `Display Name` - название приложения на экране смартфона 
-- `Version` - версия приложения для магазина 
-- `Build` - версия сборки для `TestFlight` 
-
-### Публикация приложения
-#### TestFlight
-1. Скачать актуальную версию репозитория
-   - Если ранее не скачивал, можно скачать по зеленой кнопке сверху с текстом `Code -> Open with Xcode`
-   - Если ранее скачивал, то открываешь `Xcode`, в верхней панели нажать `Source Control -> Pull`
-2. Открыть `Xcode` и дождаться загрузки зависимостей; при возникновении ошибок можно:
-   -  почистить `Derived Data` и память билда (`command + shift + k`)
-   -  обновить зависимости (`File -> Packages -> Reset/Resolve/Update`)
-3. В верхней панели Xcode сменить девайс на `Any iOS Device`
-4. В верхней панели нажать `Product -> Archive`
-5. Дождаться архивации, в открывшемся окне со сборками выбрать нужную и нажать **Distribute App**
-6. Пройти по всем шагам и снять галку с автоматического изменения версии сборки на одном из финальных шагов
-
-#### AppStore
-1. Открыть страницу с приложением в **AppstoreConnect**
-2. В левом меню рядом с версией в статусе **Готово к продаже** нажать `+` и добавить новую версию
-3. Заполнить поле **Что нового в этой версии**
-4. Ниже в разделе **Сборка** выбрать нужную сборку из `TestFlight`
-5. Ниже на странице проверить галки
-   - *Выпустить эту версию автоматически*
-   - *Выпустить обновление сразу для всех пользователей*
-   - *Сохранить текущую оценку*
-6. Нажать сверху справа кнопку **Сохранить**
-7. Отправить приложение на проверку
-
-### Скриншоты  
-1. Генерируем скриншоты при помощи `Fastlane` ([документация](https://docs.fastlane.tools/getting-started/ios/setup/))
-2. Настройки для генерации скриншотов находятся в [Snapfile](./fastlane/Snapfile) ([документация](https://docs.fastlane.tools/actions/snapshot/))
-3. Генерация скриншотов выполняется командой в папке с проектом (команда может меняться в зависимости от способа установки `Ruby`/`fastlane`)
-```shell
-rbenv exec fastlane snapshot
-```
-4. Для генерации скриншотов **необходимо наличие в Xcode симуляторов с нужной версией iOS** в соответствие с настройками в [Snapfile](./fastlane/Snapfile)
-5. Если тесты падают с ошибкой при запуске через `fastlane`, нужно убедиться, что при ручном запуске тестов из `Xcode` они успешно проходят во всех локализациях, используемых для создания скриншотов
-6. Готовые скриншоты сохраняются в папке [screenshots](./fastlane/screenshots)
-
-| Список площадок | Площадка | Прошедшие мероприятия | Мероприятие | Профиль |
-| --- | --- | --- | --- | --- |
-| <img src="./fastlane/screenshots/ru/iPhone 16 Pro Max-1-sportsGroundsList.png"> | <img src="./fastlane/screenshots/ru/iPhone 16 Pro Max-2-sportsGroundDetails.png"> | <img src="./fastlane/screenshots/ru/iPhone 16 Pro Max-3-pastEvents.png"> | <img src="./fastlane/screenshots/ru/iPhone 16 Pro Max-4-eventDetails.png"> | <img src="./fastlane/screenshots/ru/iPhone 16 Pro Max-5-profile.png"> |
-
-#### Модели девайсов, используемые для скриншотов
-По состоянию на 2025 год Apple берет за основу скриншоты для диагонали 6.9 (или 6.7) дюймов и масштабирует их под все остальные размеры экранов, то есть при желании можно использовать для скриншотов только один девайс.
-Поскольку в этом проекте подключен и работает `fastlane snapshot`, используем три девайса:
-- iPhone 16 Pro Max
-- iPhone 16 pro
-- iPhone SE (3rd generation)
-
-Список всех существующих девайсов есть [тут](https://www.ios-resolution.com).
-
-### Форматирование кода
-- Используем [swiftformat (0.55.5)](https://github.com/nicklockwood/SwiftFormat) для форматирования кода
-- Правила форматирования перечислены в файле [.swiftformat](.swiftformat)
-- Все правила можно найти [тут](https://github.com/nicklockwood/SwiftFormat/blob/master/Rules.md)
-
-#### Как это работает
-1. Перед каждым пушом должен выполняться хук, проверяющий необходимость форматирования кода
-2. При нарушении правил форматирования кода, гит выдаст ошибку и напишет команду, которую нужно выполнить для запуска `swiftformat`
-
-#### Как обновить `swiftformat`
-1. Переходим на [страницу с релизами](https://github.com/nicklockwood/SwiftFormat/releases)
-2. Скачиваем `swiftformat.zip`
-3. Заменяем в папке с проектом старый файл `swiftformat` на новый
-4. Если при первом запуске форматирования после обновления файла система выдает алерт и не запускает скрипт, даем разрешение на запуск этого файла в `системных настройках -> конфиденциальность и безопасность`
-
 ## Реализованный функционал
 - Большинство возможностей требуют подключения к интернету, но некоторые фичи доступны оффлайн
 - Звездочкой отмечены фичи только для авторизованных пользователей
@@ -165,3 +70,105 @@ rbenv exec fastlane snapshot
 - Просмотр текущей версии приложения
 - Перейти на сайт магазина workout
 - Просмотр логов сетевых запросов (только в режиме разработки)
+
+## Помощь проекту
+Прежде чем что-то делать, ознакомься с [правилами](.github/CONTRIBUTING.md), пожалуйста.
+
+### Установка и настройка проекта
+1. Убедись, что у тебя установлен Xcode 16+
+2. Клонируй репозиторий
+3. В терминале перейди в папку с проектом 
+```shell
+cd SwiftUI-WorkoutApp
+```
+4. Настрой гит хуки
+```shell
+# Активируем локальные хуки для этого репозитория
+git config core.hooksPath ./githooks
+
+# Даем права на выполнение pre-push хука
+chmod +x githooks/pre-push
+```
+5. Открыть проект в через файл `SwiftUI-WorkoutApp.xcodeproj` и дождаться загрузки зависимостей
+6. Проект готов к работе!
+
+#### Что делает pre-push хук
+Хук выполняет двухэтапную проверку перед отправкой изменений:
+1. Блокирует прямой `push` в ветку `main`
+2. Запускает `SwiftFormat` в режиме линтера: если нарушены правила форматирования кода, вылезет ошибка, подробнее можно почитать [тут](#форматирование-кода)
+
+### Форматирование кода
+- Используем [SwiftFormat (0.55.5)](https://github.com/nicklockwood/SwiftFormat) для форматирования кода
+- Правила форматирования перечислены в файле [.swiftformat](.swiftformat)
+- Все правила можно найти [тут](https://github.com/nicklockwood/SwiftFormat/blob/master/Rules.md)
+- Для запуска форматирования нужно в папке с проектом выполнить команду (точка после пробела тоже нужна):
+```shell
+./swiftformat .
+```
+
+#### Как это работает
+1. Перед каждым пушом должен выполняться хук, проверяющий необходимость форматирования кода
+2. При нарушении правил форматирования кода, гит выдаст ошибку и напишет команду, которую нужно выполнить для запуска `SwiftFormat`
+
+#### Как обновить SwiftFormat
+1. Переходим на [страницу с релизами](https://github.com/nicklockwood/SwiftFormat/releases)
+2. Скачиваем `swiftformat.zip`
+3. Заменяем в папке с проектом старый файл `swiftformat` на новый
+4. Отправляем **PR** с изменениями
+5. Если при первом запуске форматирования после обновления файла система выдает алерт и не запускает скрипт, даем разрешение на запуск этого файла в `системных настройках -> конфиденциальность и безопасность`
+
+## Шпаргалка
+### Настройка базовых параметров приложения  
+`Xcode -> SwiftUI-WorkoutApp -> Target: SwiftUI-WorkoutApp -> General`
+- `Display Name` - название приложения на экране смартфона 
+- `Version` - версия приложения для магазина 
+- `Build` - версия сборки для `TestFlight` 
+
+### Публикация приложения
+#### TestFlight
+1. Скачать актуальную версию репозитория
+   - Если ранее не скачивал, можно скачать по зеленой кнопке сверху с текстом `Code -> Open with Xcode`
+   - Если ранее скачивал, то открываешь `Xcode`, в верхней панели нажать `Source Control -> Pull`
+2. Открыть `Xcode` и дождаться загрузки зависимостей; при возникновении ошибок можно:
+   -  почистить `Derived Data` и память билда (`command + shift + k`)
+   -  обновить зависимости (`File -> Packages -> Reset/Resolve/Update`)
+3. В верхней панели Xcode сменить девайс на `Any iOS Device`
+4. В верхней панели нажать `Product -> Archive`
+5. Дождаться архивации, в открывшемся окне со сборками выбрать нужную и нажать **Distribute App**
+6. Пройти по всем шагам и снять галку с автоматического изменения версии сборки на одном из финальных шагов
+
+#### AppStore
+1. Открыть страницу с приложением в **AppstoreConnect**
+2. В левом меню рядом с версией в статусе **Готово к продаже** нажать `+` и добавить новую версию
+3. Заполнить поле **Что нового в этой версии**
+4. Ниже в разделе **Сборка** выбрать нужную сборку из `TestFlight`
+5. Ниже на странице проверить галки
+   - *Выпустить эту версию автоматически*
+   - *Выпустить обновление сразу для всех пользователей*
+   - *Сохранить текущую оценку*
+6. Нажать сверху справа кнопку **Сохранить**
+7. Отправить приложение на проверку
+
+### Скриншоты  
+1. Генерируем скриншоты при помощи `Fastlane` ([документация](https://docs.fastlane.tools/getting-started/ios/setup/))
+2. Настройки для генерации скриншотов находятся в [Snapfile](./fastlane/Snapfile) ([документация](https://docs.fastlane.tools/actions/snapshot/))
+3. Генерация скриншотов выполняется командой в папке с проектом (команда может меняться в зависимости от способа установки `Ruby`/`fastlane`)
+```shell
+rbenv exec fastlane snapshot
+```
+4. Для генерации скриншотов **необходимо наличие в Xcode симуляторов с нужной версией iOS** в соответствие с настройками в [Snapfile](./fastlane/Snapfile)
+5. Если тесты падают с ошибкой при запуске через `fastlane`, нужно убедиться, что при ручном запуске тестов из `Xcode` они успешно проходят во всех локализациях, используемых для создания скриншотов
+6. Готовые скриншоты сохраняются в папке [screenshots](./fastlane/screenshots)
+
+| Список площадок | Площадка | Прошедшие мероприятия | Мероприятие | Профиль |
+| --- | --- | --- | --- | --- |
+| <img src="./fastlane/screenshots/ru/iPhone 16 Pro Max-1-sportsGroundsList.png"> | <img src="./fastlane/screenshots/ru/iPhone 16 Pro Max-2-sportsGroundDetails.png"> | <img src="./fastlane/screenshots/ru/iPhone 16 Pro Max-3-pastEvents.png"> | <img src="./fastlane/screenshots/ru/iPhone 16 Pro Max-4-eventDetails.png"> | <img src="./fastlane/screenshots/ru/iPhone 16 Pro Max-5-profile.png"> |
+
+#### Модели девайсов, используемые для скриншотов
+По состоянию на 2025 год Apple берет за основу скриншоты для диагонали 6.9 (или 6.7) дюймов и масштабирует их под все остальные размеры экранов, то есть при желании можно использовать для скриншотов только один девайс.
+Поскольку в этом проекте подключен и работает `fastlane snapshot`, используем три девайса:
+- iPhone 16 Pro Max
+- iPhone 16 pro
+- iPhone SE (3rd generation)
+
+Список всех существующих девайсов есть [тут](https://www.ios-resolution.com).
