Open Source README Generator

This skill helps you generate professional, comprehensive, and visually appealing README files for open-source projects.

Usage Guidelines

When a user asks to create or improve a README:

1. Analyze the Project:

   • Look at the files in the current directory (using ls -R or similar tools if allowed/safe) to understand the project type (Node.js, Python, Go, etc.).
   • Identify key components: package.json, requirements.txt, source code folders, tests.
   • Determine the project name and purpose.

2. Gather Information:

   • If the project purpose isn't clear from the code, ask the user for a brief description, "elevator pitch", or key features.
   • Ask about specific sections if they are missing (e.g., "Do you have a demo link?", "What is the license?").