README Generator for VS Code

Demo Video

Below is a demo video showcasing how to use the README Generator for VS Code.

Overview

The README Generator for VS Code is a powerful extension that helps you automatically generate detailed README.md files for your projects using AI. This tool saves you time and effort by ensuring your project documentation is comprehensive, well-structured, and professional.

NOTE Please be aware that the API used in this project has a rate limit. If the project does not work as expected, try to fork the project locally and then add your API key to avoid rate limit issues. This is the original repo of this project Generate README

Features

• Automated README Generation: Generate a README.md file with a single command.
• Customizable Sections: Include specific sections such as Installation, Usage, Contributing, and more.
• AI-Powered Content: Utilizes AI to create detailed and relevant content based on your project.
• User-Friendly Interface: Simple and intuitive commands to generate and customize your README.

Usage

1. Enter API Key: On first use, you will be prompted to enter your Gemini or OpenAI API key. This key will be stored securely.
2. Right-Click on a Folder: Navigate to the folder for which you want to generate a README. Right-click on the folder in the Explorer pane.
3. Select Generate README: From the context menu, select the Generate README option.
4. Automatic Generation: The extension will automatically generate a README.md file based on the content and structure of your project.

Sections Included

The generated README.md includes the following sections:

• Project Title: The name of your project.
• Description: A brief description of what your project does.
• Installation: Instructions on how to install and set up your project.
• Usage: How to use your project.
• Contributing: Guidelines for contributing to your project.
• License: Information about the project's license.

Contributing

We welcome contributions from the community! If you'd like to contribute, please fork the repository and submit a pull request.

License

This project is licensed under the MIT License.

Contact

For any questions or feedback, feel free to open an issue on GitHub or contact the project maintainer.

Thank you for using the README Generator for VS Code! We hope it helps you create great documentation for your projects.