Create GitHub README
npx machina-cli add skill alfredang/courseware_claude_agents/create_github_readme --openclawCreate GitHub README
Command
/create_github_readme or create_github_readme
Navigate
Documentation
Keywords
readme, github readme, create readme, generate readme, project readme, documentation, readme.md, update readme, write readme, project documentation
Description
Generate a professional GitHub README.md file for the WSQ Courseware Generator project following open standards and best practices.
Execution
This skill runs using Claude Code with subscription plan. Do NOT use pay-as-you-go API keys. All AI operations should be executed through the Claude Code CLI environment with an active subscription.
Response
I'll generate a comprehensive GitHub README.md for the project.
The README will include:
| Section | Description |
|---|---|
| Header | Project name, badges, tagline, links |
| About | Project description and key features |
| Tech Stack | Technologies used with badges |
| Architecture | System diagram (ASCII art) |
| Project Structure | File/folder organization |
| Getting Started | Prerequisites, installation, running |
| Deployment | Docker, Hugging Face Spaces instructions |
| Contributing | Fork, PR workflow, discussions |
| Developed By | Tertiary Infotech Academy Pte. Ltd. |
| Acknowledgements | Credits and thanks |
Instructions
When generating a README, follow this open standard structure:
1. Header Section
<div align="center">
# Project Name
[](link)
[](link)
**Tagline**
[Demo](url) · [Report Bug](url) · [Request Feature](url)
</div>
2. Required Badges
- Python version
- Framework (Chainlit)
- AI Provider (Claude/Anthropic)
- License
- Docker
- Deployment platform
3. About Section
- Brief description (2-3 sentences)
- Key features as bullet points or table
- Platform statistics (optional)
4. Tech Stack
Table format with categories:
- Frontend
- Backend
- AI/LLM
- Database
- Deployment
- Document Processing
5. Architecture Diagram
ASCII art showing:
- UI layer
- Application layer
- AI agents
- Data/document layer
6. Project Structure
project/
├── app.py
├── modules/
└── ...
7. Getting Started
- Prerequisites
- Clone & install steps
- Environment setup
- Run command
8. Deployment
- Docker instructions
- Cloud platform instructions
9. Contributing
- Fork instructions
- PR workflow
- Link to discussions
10. Footer
- Developed by: Company name
- Acknowledgements: Credits
- Call to action: Star the repo
Capabilities
- Generate complete README.md following GitHub best practices
- Include technology badges with shields.io
- Create ASCII architecture diagrams
- Document file structure
- Provide multi-platform deployment instructions
- Add proper attribution and acknowledgements
Next Steps
After generating the README:
- Review and customize content for your project
- Update placeholder URLs and usernames
- Add screenshots if available
- Verify all links work
- Commit to repository
Source
git clone https://github.com/alfredang/courseware_claude_agents/blob/main/.claude/skills/create_github_readme/SKILL.mdView on GitHub Overview
This skill generates a complete GitHub README.md for the WSQ Courseware Generator project, adhering to open standards and best practices. It includes tech badges, an ASCII architecture diagram, setup and deployment steps, and an acknowledgements section to credit contributors.
How This Skill Works
The generator follows a fixed README structure: Header with badges, About, Tech Stack, Architecture Diagram, Project Structure, Getting Started, Deployment, Contributing, and Acknowledgements. Badges use shields.io URLs, the architecture is rendered as ASCII art, and the file tree example illustrates project layout.
When to Use It
- When starting a new project and you need a polished, ready-to-push README.md.
- When documenting architecture, deployment steps, and contribution guidelines in a single file.
- When standardizing repository documentation across multiple projects.
- When including technology badges and deployment platform details in the README.
- When preparing a repository for open-source sharing or teaching materials.
Quick Start
- Step 1: Run the skill with /create_github_readme or create_github_readme.
- Step 2: Provide project details (name, description, repo links, badges) if prompted.
- Step 3: Copy the generated README.md to your repo and customize URLs and screenshots.
Best Practices
- Follow the open standard structure: header, about, tech stack, architecture, project structure, getting started, deployment, contributing, acknowledgements.
- Use shields.io badges for Python version, framework, license, Docker, deployment platform, etc.
- Include a clear ASCII architecture diagram covering UI, application, AI agents, and data layers.
- Provide a realistic project structure example and actionable getting started steps.
- Include proper attribution and a call to action to star the repo.
Example Use Cases
- WSQ Courseware Generator README with badges, ASCII architecture, and setup steps.
- ML project README including model dependencies, deployment instructions, and licensing.
- CLI tool repository README with usage examples and contributing guidelines.
- Web app README detailing frontend/backend stack, Docker deployment, and testing steps.
- Library/documentation README featuring tech badges, architecture diagram, and release notes.
