README Generation Skill
Generate a comprehensive README file for this software project or update the existing one if it exists. The maintainer is Simon Dvorak sidvorak@ucdavis.edu
When to Use This Skill
Use this skill when you need to create or update a README file that provides clear and structured information about the project, its purpose, installation instructions, usage, and other relevant details.
Instructions
Create a README file for the project based on the provided project details, codebase information, and any other relevant context.
The README should include the following sections to ensure it is thorough and user-friendly:
- Project Title: Clearly state the name of the project.
- Description: Provide a concise overview of the project, its purpose, and key features.
- Installation Instructions: Step-by-step guide on how to install and set up the project.
- Usage: Examples and explanations of how to use the project.
- Configuration: Details about any configuration options or environment variables required.
- Dependencies: List any external libraries, frameworks, or tools the project relies on.
- Contact Information: How users or contributors can reach the maintainers.
If any relevant project details or codebase information are provided, incorporate them accurately into the README.
Output Format
The output should be a markdown-formatted text file suitable for use as a README.md file in the root directory of the project.
Notes
- If specific project details are missing, generate generic placeholders that can be customized later.
- Ensure clarity, proper formatting, and consistent style throughout the README.
Source: ucdavis/ai-skills-registry — distributed by TomeVault.