Требования к ReadMe

📌 Если есть трудности с оформлением ReadMe или обстоятельства, которые мешают этому напишите t.me/Daniil_Y.

Критерии, описанные ниже могут быть адаптированы под различные обстоятельства. Например, если речь идет о проекте с ML-соревновании, где не требовалось сделать UI, то этот пункт не обязателен.

Эти правила не распространяются на победы и достижения в сфере спортивного программирования.

---

1. Заголовок и краткое описание проекта

• Название проекта

• Краткое описание — в 1-2 предложениях объяснить, что это за проект и какую проблему он решает. В рамках какого хакатона и для какого заказчика был создан.

---

2. Установка и запуск проекта

• Простая инструкция для клонирования и запуска проекта:

• Какие зависимости нужно установить.

• Как настроить окружение.

• Как запустить проект локально или через контейнеры (например, Docker).

---

3. Основной функционал проекта

• Список ключевых функций и возможностей проекта.

---

4. Технологии и инструменты

• Укажите используемые технологии, языки программирования, библиотеки, фреймворки и платформы.

• Крайне желательно добавить значки (badges) для визуализации технологий.

---

5. Команда проекта

• Состав команды (контрибьюторы). Даже те, кто не писали код.

• Роли и вклад каждого члена команды в проект (например, разработка фронтенда, работа с базами данных, дизайн интерфейса).

• Желательно ссылки на профили GitHub или любую другую индустриальную социальную сеть (Behance для дизайнеров, например, или универсальный LinkedIn).

---

6. Желательно - архитектура и структура проекта

• Описание структуры папок и файлов.

• Диаграмма архитектуры (очень вероятно, что была в презентации)

---

7. Демонстрация работы проекта

• Скриншоты приложения или интерфейса.

• Если возможно, то ссылка на GitHub Pages, Netlify, Heroku

---

8. Финальный текст-заключение

• Почему этот проект важен или интересен. Чем он отличается от аналогов или как решает проблему лучше других.

• Какие улучшения возможно добавить и как улучшить проект.

---

10. Лицензия

• Укажите, под какой лицензией распространяется проект (например, MIT, GPL, или другой открытый стандарт).

---

Примеры для вдохновения

Предложите студентам посмотреть примеры качественных README:

• Awesome README — подборка хороших README.

• GitHub README Templates — еще одна подборка.

---

Что если я имею победу на креатоне или другом ИТ-соревновании подобного формата?

---

Для участников CTF