15 елементів, які слід включити у ваш документ README
- Назва проекту. Перше, що мають побачити користувачі після відкриття вашого файлу README, це назва проекту. …
- Опис проекту. …
- Зміст. …
- Технології, що використовуються. …
- Вимоги. …
- Інструкції з монтажу. …
- Інструкція з використання. …
- Документація.
Що включити в README
- Назва проекту. Це назва проекту. …
- Опис проекту. Це важливий компонент вашого проекту, який багато нових розробників часто не помічають. …
- Зміст (необов'язково) …
- Як встановити та запустити проект. …
- Як користуватися проектом. …
- Включити кредити. …
- Додайте ліцензію. …
- Значки.
Створіть файл ReadMe
- Створіть файл із назвою README.md у кореневій (основній) папці сховища Git.
- Додайте будь-які інструкції чи документацію, якою хочете поділитися з іншими. Використовуйте Markdown для форматування заголовків, списків, посилань тощо…
- Після завершення зафіксуйте зміни та надішліть їх до віддаленого репо.
розділи README
- Назва проекту та вступ (обов’язково)
- Зміст (необов'язково)
- Вимоги (обов'язково)
- Рекомендовані модулі (опціонально)
- Інсталяція (обов’язкова, якщо не надається окремий INSTALL.md)
- Конфігурація (обов'язково)
- Усунення несправностей і поширені запитання (необов’язково)
- Супроводжувачі (необов'язково)
Типовий файл readme містить назву сховища та деякі основні інструкції. Формат файлу — «md», що означає Документація щодо уцінки. Це легка мова розмітки, яку можна легко перетворити на текст.