ReadMeUp is a Visual Studio Code extension that automatically generates a professional README.md file for your project. By analyzing your project's folder structure and file types, it constructs a comprehensive starting point for your documentation.
Features
Automatic Folder Structure: Scans your project and generates a tree view of your files.
Language Detection: Identifies programming languages used in your project based on file extensions.
Interactive Prompts: Asks for project description and key features to personalize the content.
Standard Usage & Installation: Includes template sections for you to fill in details.
Badge Integration: Adds placeholders for common badges.
How to Use
Open a folder in VS Code.
Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P).
Type Generate README and select the command.
Follow the prompts to enter a project description and features.
A README.md file will be generated in your project root. (It will overwrite any existing README.md).
Installation
Install via the Visual Studio Code Marketplace (Search for "ReadMeUp").
Or manually package this extension and install the .vsix file.
Requirements
VS Code version 1.80.0 or higher.
Extension Settings
This extension currently has no configurable settings.
Known Issues
Large node_modules or hidden directories are excluded from the tree view for performance, but deeply nested custom folders might still generate a large tree.
