README учебного проекта: запуск без догадок

Назначение

Короткий README фиксирует назначение проекта, способ локального просмотра и границы готовности.

Как это работает

Полезно указать состав файлов, требуемые инструменты и проверенные действия. Если форма пока не отправляет данные или используются демонстрационные изображения, это лучше написать явно.

Пример

# Учебный сайт

Назначение: практика HTML и CSS.
Запуск: локальный HTTP-сервер из папки проекта.
Проверено: главная страница, ссылки, узкая ширина.
Ограничение: форма демонстрационная, данные не отправляет.

Что должно получиться

Инструкция отделяет назначение, запуск и ограничения. Названные проверки нужно заменить фактически выполненными для своего проекта, а не копировать как готовое подтверждение.

Граница применения и частая ошибка

Не помещайте пароли и закрытые адреса в инструкцию, которая может попасть в репозиторий. И не отмечайте непроверенные функции как готовые только потому, что кнопка уже нарисована.

Самостоятельная проверка

Попросите проверить инструкцию на копии проекта либо сами пройдите её с чистого каталога. Исправьте каждый шаг, который требует знания, отсутствующего в тексте.

Связанные материалы

• Локальный HTTP-просмотр
• Просмотр изменений
• Проверка публикации