Smart README GeneratorAutomatically generate professional README.md files by scanning your project structure and dependencies. Installation Launch VS Code Quick Open ( Ctrl+P), paste the following command, and press enter.Copied to clipboard |
Smart README Generator Turn your project into professional documentation with one click. Smart README Generator is a Visual Studio Code extension that helpsdevelopers create professional README.md files automatically byanalyzing their project structure, technologies, and dependencies. Instead of writing project documentation from scratch, you can generatea useful README directly inside VS Code. ✨ Features 🤖 Automatic README Generation Generate a professional README.md with a simple command. 📁 Project Structure Analysis Analyze your project's folders and files. 📦 Dependency Detection Detect project dependencies and include relevant information. 💻 Technology Detection Identify technologies used in your project. 🌳 Project Structure Generate a readable folder and file structure. 🏷️ Technology Badges Add technology badges to make your README more professional. 👀 README Preview Preview your generated README directly inside VS Code. ⚙️ Customizable Settings Choose whether to include technology badges and projectstructure. ⚡ Fast and Simple Generate documentation without leaving your developmentenvironment. 🚀 How to Use
Open the project you want to document in Visual Studio Code.
Click the Smart README icon from the Activity Bar.
Use the command: Smart README: Generate README The extension will analyze your project and generate a README.md file.
Use: Smart README: Preview README to preview your generated documentation. ⌨️ Available Commands Open the VS Code Command Palette with: Ctrl + Shift + P Then search for: Smart README: Generate README or: Smart README: Preview README ⚙️ Configuration Smart README Generator provides settings to customize the generateddocumentation. Include Technology Badges "smartReadme.includeBadges": true Controls whether technology badges are included in the generated README. Include Project Structure "smartReadme.includeStructure": true Controls whether the project folder structure is included in thegenerated README. 📸 Screenshots Add your extension screenshots to a screenshots folder and update theimage paths below. Smart README Generator README Generation README Preview 📦 Installation Search for Smart README Generator in the Visual Studio CodeMarketplace and click Install. 🎯 Why Use Smart README Generator? Good documentation makes software projects easier to understand,maintain, share, and collaborate on. Smart README Generator reduces repetitive documentation work byanalyzing your project and creating a professional starting pointautomatically. It is useful for: Personal projects University and FYP projects Portfolio projects Open-source projects Professional applications 🛠️ Project Information Extension: Smart README GeneratorPublisher: MuhammadTakmeelLicense: MIT 🔮 Future Improvements Planned improvements may include: 🤖 AI-powered README generation 🌐 Improved programming-language detection 🎨 More README templates 🔗 Automatic repository information 📊 Additional project analysis 🧩 More customization options 🐛 Feedback and Issues Found a bug or have a feature suggestion? Please report it through the project's issue tracker so it can bereviewed and improved. 📄 License This project is licensed under the MIT License. ⭐ Support If you find Smart README Generator useful, consider sharing it withother developers and supporting the project. Smart README GeneratorProfessional project documentation, generated automatically. |