Skip to content
Snippets Groups Projects
Select Git revision
  • 1.0.x default
  • 1.0.0
2 results
Name Last commit Last update
src
.gitlab-ci.yml
README.md
ai_readme_generator.info.yml
ai_readme_generator.links.menu.yml
ai_readme_generator.routing.yml
composer.json
drush.services.yml
README.md

CONTENTS OF THIS FILE

  • Introduction
  • Requirements
  • Installation
  • Recommended modules
  • Configuration
  • Maintainers

AI Readme Generator

Introduction

The AI Readme Generator is a Drupal module that uses Artificial Intelligence to generate README.md files for Drupal modules. With an ability to recognize code structure, it simplifies the often time-consuming task of documentation by auto-generating readable, comprehensive README.md

Requirements

None

Installation

composer require drupal/ai_readme_generator

Recommended modules

None

Configuration

To configure the module after enabling it, follow the steps below:

  • Navigate to the module configuration page.
  • In the AI Configuration Form, choose AI provider, fill API Key and select module
  • In the Generate Readme Form, specify the modules for which README.md files are to be generated.
  • You can also generate README.md by using drush command: "drush readme-generate module_machine_name".

Maintainers