11.1K ·GitHub
Что это такое?
CLI-инструмент, который генерирует файл README.md для вашего проекта, задаёт серию вопросов и заранее подставляет разумные значения по умолчанию.
CLI-инструмент, который генерирует файл README.md для вашего проекта, задаёт серию вопросов и заранее подставляет разумные значения по умолчанию.Это библиотека, которую я импортирую, или самостоятельный CLI?Это самостоятельный инструмент командной строки, который запускается через npx, а не библиотека, которую импортируют в код.
Это самостоятельный инструмент командной строки, который запускается через npx, а не библиотека, которую импортируют в код.Как с его помощью сгенерировать README?Выполните команду в корне проекта и ответьте на вопросы, которые будут заданы, или полностью пропустите их с флагом -y, чтобы использовать значения по умолчанию для всех вопросов.
Выполните команду в корне проекта и ответьте на вопросы, которые будут заданы, или полностью пропустите их с флагом -y, чтобы использовать значения по умолчанию для всех вопросов.Нужно ли сначала установить Node и npm?Да, требуется npm 5.5.0+ и node 9.3.0+, так как запуск происходит через npx.
Да, требуется npm 5.5.0+ и node 9.3.0+, так как запуск происходит через npx.Насколько умны предлагаемые значения по умолчанию?Инструмент читает ваш package.json и конфигурацию git, чтобы предлагать значения по умолчанию во время создания README, поэтому качество подсказок зависит от того, насколько полными заполнены метаданные в вашем package.json.
Инструмент читает ваш package.json и конфигурацию git, чтобы предлагать значения по умолчанию во время создания README, поэтому качество подсказок зависит от того, насколько полными заполнены метаданные в вашем package.json.Можно ли изменить шаблон README, который он генерирует?Да, можно передать свой шаблон EJS с помощью флага -p вместо встроенного.
Да, можно передать свой шаблон EJS с помощью флага -p вместо встроенного.Какую информацию он автоматически берёт из моего проекта?Он считывает поля package.json (например, name, description, author) и конфигурацию git, чтобы заранее заполнить ответы, например имя репозитория и данные об авторе.
Он считывает поля package.json (например, name, description, author) и конфигурацию git, чтобы заранее заполнить ответы, например имя репозитория и данные об авторе.What are similar projects?jsdoc, http-server, oc, clarity, Best-README-Template, node-gyp, yeoman, nodemon
jsdoc, http-server, oc, clarity, Best-README-Template, node-gyp, yeoman, nodemonWhich topics is it in?npx, generator, readme, command-line, documentation, markdown, productivity, command-line-tool, npm, terminal, tool, nodejs
npx, generator, readme, command-line, documentation, markdown, productivity, command-line-tool, npm, terminal, tool, nodejs