Reponote LogoReponote

Documentation

Reponote helps you create professional README files for your GitHub repositories using AI. This guide will walk you through all the features and how to use them effectively.

Getting Started

To get started with Reponote:

  1. Sign in with your GitHub account
  2. Select a repository from your list
  3. Choose which files to include in the README generation
  4. Generate and customize your README

Features

File Selection

Reponote allows you to select specific files from your repository to include in the README generation process.

  • Browse your repository's file structure
  • Select individual files or entire directories
  • Files under 1500 characters are automatically included without summarization
  • Larger files are summarized to capture their key functionality

AI-Powered Generation

Reponote uses advanced AI models to generate professional README files.

Free Tier

Uses DeepSeek's model to generate READMEs with basic features.

Pro/Lifetime Tier

Access to GPT-4.1 for more sophisticated README generation with:

  • Better context understanding
  • More accurate technical descriptions
  • Improved formatting and structure

README Structure

Generated READMEs follow a professional structure with these sections:

  1. Project Overview
  2. Tech Stack
  3. Installation & Setup
  4. Project Structure
  5. License
  6. Contributors

Best Practices

File Selection

  • Include key configuration files (e.g., package.json, requirements.txt)
  • Select main application files that show core functionality, e.g. files that describe the purpose of the project
  • Include setup/installation scripts if available
  • Avoid selecting test files or temporary files

README Customization

  • Review and edit the generated README before saving
  • Ensure all links and paths are correct
  • Add any project-specific information not detected by the AI
  • Verify that the tech stack is accurately represented

Troubleshooting

Common Issues

  • GitHub Authentication Issues

    Try logging out and logging back in to refresh your GitHub token.

  • File Access Errors

    Ensure your GitHub token has the necessary repository access permissions.

  • AI Generation Failures

    Try reducing the number of selected files or selecting different files.