ReadGen logo

ReadGen

v1.0

Input

Project details

Choose a source mode, then provide a repository URL or a few project details for the README generator to work from.

Use a public repository as the source.

Paste a public GitHub repository URL and the generator will use the repository metadata as source material for the README draft.

Preview

README preview

The preview shows generated markdown based on GitHub metadata or the manual details currently provided.

Untitled README

Generated markdown preview

# Project Name

## Description

Click **Generate README** to create a draft from a GitHub repository or the manual project details you provide.

## Installation

Installation steps will be generated here.

## Usage

Usage guidance will be generated here.