RepoReadme README Generator

Automatically analyze repositories and generate professional README documentation with intelligent technology detection and customizable templates.

What This Skill Does

This skill guides you through using RepoReadme, a Python-based README generator that:

Prerequisites

Before using this skill, ensure you have:

Step-by-Step Instructions

1. Environment Setup

First, verify Python version and install dependencies:

```bash

Check Python version (must be 3.10+)

python --version

Install all required dependencies

pip install -r requirements.requirements.txt

```

**Key dependencies:**

2. Choose Your Interface

**Option A: GUI Application (Recommended for exploration)**

Launch the graphical interface with repository management and live preview:

```bash

python main.py

```

Features:

**Option B: CLI (Recommended for automation)**

Generate README directly from command line:

```bash

python demo.py <repository_path> --template modern --output README.md

```

3. Select Template Style

Choose from 6 professional templates based on your project type:

| Template | Best For | Characteristics |

|----------|----------|-----------------|

| `modern` | General projects | Badges, emojis, visual appeal |

| `classic` | Traditional projects | Simple, professional format |

| `minimalist` | Clean documentation | Ultra-focused, essential info only |

| `developer` | Technical projects | Architecture details, API docs |

| `academic` | Research projects | Citations, methodology, results |

| `corporate` | Business projects | Compliance, licensing, enterprise focus |

**CLI example with template:**

```bash

python demo.py ./my-project --template developer --output README.md

```

4. Repository Analysis

The analyzer (`src/analyzers/repository_analyzer.py`) automatically detects:

**Analysis is cached** in `cache/` directory for faster repeated generations.

5. Customize Output (Optional)

**GUI customization:**

**CLI customization:**

Edit `config/settings.json` to set defaults:

```json

{

"template": "modern",

"include_badges": true,

"include_emojis": true,

"github_token": "your-token-here"

}

```

6. Generate README

**In GUI:**

1. Select repository from list

2. Choose template

3. Configure options

4. Click "Generate README"

5. Preview in built-in viewer

6. Click "Save" to export

**In CLI:**

```bash

Basic generation

python demo.py ./my-repo

With all options

python demo.py ./my-repo \

--template modern \

--output ./my-repo/README.md \

--badges \

--emojis

```

**Output location:**

7. Review and Refine

1. **Review generated content** in your editor or GUI preview

2. **Verify accuracy** - Technology detection, dependency versions

3. **Add custom sections** - The generator creates structure; you add specifics

4. **Update badges** - Replace placeholder URLs with actual CI/CD, coverage links

5. **Personalize** - Add screenshots, examples, unique project details

8. GitHub Authentication (Optional)

For enhanced GitHub API access (higher rate limits, private repos):

1. Generate personal access token at https://github.com/settings/tokens

2. Configure in settings:

- **GUI:** Settings menu → GitHub Token

- **CLI:** Edit `config/settings.json`

- **Code:** Use `src/config/github_auth.py`

```python

from src.config.github_auth import configure_github_token

configure_github_token("ghp_your_token_here")

```

Architecture Reference

Key Components

**Core modules:**

**Entry points:**

**Design patterns:**

Directory Structure

```

RepoReadme/

├── src/

│ ├── analyzers/ # Repository analysis

│ ├── templates/ # README templates

│ ├── config/ # Settings management

│ ├── utils/ # Logging, helpers

│ └── gui.py # GUI application

├── cache/ # Analysis cache

├── logs/ # Application logs

├── output/ # Generated READMEs

├── main.py # GUI launcher

└── demo.py # CLI interface

```

Troubleshooting

**"Module not found" errors:**

**GitHub API rate limiting:**

**GUI not launching:**

**Inaccurate technology detection:**

Examples

Example 1: Generate README for Python Project

```bash

Analyze Python repository with modern template

python demo.py ./my-python-app --template modern --output README.md

```

**Expected output:**

Example 2: Batch Process Multiple Repos (GUI)

1. Launch GUI: `python main.py`

2. Click "Add Repository" → Select multiple folders

3. Choose template for all: `developer`

4. Enable batch mode

5. Click "Generate All"

6. Review each README in preview pane

Example 3: Custom Template (Advanced)

Create new template in `src/templates/`:

```jinja2

{# custom.jinja2 #}

{{ metadata.name }}

> {{ metadata.description }}

Quick Start

```bash

{{ metadata.install_command }}

```

Tech Stack

{% for tech in metadata.technologies %}

{% endfor %}

```

Use with:

```bash

python demo.py ./repo --template custom

```

Important Notes

Next Steps

After generating your README:

1. **Commit to repository**: `git add README.md && git commit -m "Add generated README"`

2. **Add screenshots** - Replace placeholders with actual project images

3. **Update badges** - Configure CI/CD integration and update badge URLs

4. **Customize examples** - Add real code snippets and usage examples

5. **Iterate** - Re-run generator after major project changes

Related Resources

---

**Note:** This skill assumes RepoReadme is already cloned and set up. For installation from scratch, clone the repository first: `git clone <repo-url> && cd RepoReadme`