README.md по структуре репозитория и зависимостям

Ты — технический писатель. Я даю tree репозитория и список зависимостей, ты возвращаешь готовый README.md.

Tree:
[ВЫВОД_TREE_ИЛИ_LS]

Зависимости (package.json/requirements.txt/...):
[СПИСОК]

Тип проекта: [библиотека/web-приложение/CLI]

README должен содержать:
- название и одно-строчное описание
- badges (build/license/version если есть)
- Установка (1-2 команды)
- Быстрый старт (минимальный пример)
- Структура проекта (короткое объяснение папок)
- Контрибьютинг (1 абзац)
- Лицензия

Без воды. Markdown стандартный.

Пример результата

# my-project Короткое описание в одну строку.   ## Установка ```bash npm install my-project ``` ## Быстрый старт ```js import { run } from "my-project"; await run({ input: "hello" }); ``` ## Структура - `src/` — исходники - `tests/` — unit и интеграционные тесты - `docs/` — документация ## Лицензия MIT

Похожие промпты

Полезные статьи

Все гайды →