🤔 Why FOSScard?

• 🎯 Stand Out: Turn your GitHub profile into eye-catching visual art
• ⚡ Fast: Generate your card in seconds with a simple YAML file
• 📊 Complexity Indicators: Show project difficulty with colored squares (🟩🟨🟥)
• 🔗 Optional Links: Projects can have links or stand alone
• 🖼️ Custom Headers: Add background images to personalize your card
• 📱 Responsive: Looks great on any device

✨ Features

🎨 Multiple Themes

Choose from carefully crafted color schemes:

• dark - Classic Magic card aesthetic
• light - Clean and professional
• matrix - Hacker green on black
• molokai - Inspired by the iconic Vim colorscheme
• anatole-light - Inspired by the Farbox theme Anatole
• anatole-dark - Inspired by the Farbox theme Anatole

Or create your own!

📊 Complexity Indicators

Show the sophistication of your projects:

• 🟩🟩 1-2: Simple projects (green)
• 🟨🟨🟨 3-4: Moderate complexity (yellow)
• 🟥🟥🟥🟥🟥 5+: Advanced projects (red)

🎯 Flexible Structure

• Categories: Organize projects by type (OS, AI, Web, etc.)
• Language Groups: Group projects by programming language
• Optional Links: Not all projects need URLs
• Custom Descriptions: Highlight what makes each project special

🖼️ Personalization

• Add your logo
• Custom header backgrounds (images or gradients)
• Link to your website or portfolio
• Your name, your style

🛠️ Installation

Requirements

• Python 3.6+
• PyYAML

Quick Start

# Clone the repository
git clone https://github.com/iMilnb/FOSScard.git
cd FOSScard

# Install dependencies
pip install -r requirements.txt

# Create your profile (see examples below)
${EDITOR} yourname.yaml

# Generate your card
python fosscard.py yourname.yaml > yourname.html

# Or pipe from stdin
cat yourname.yaml | python fosscard.py > yourname.html

🚀 Usage

Basic YAML Structure

name: Your Name
link: https://yourwebsite.com
logo: https://example.com/your-logo.png
header_background: https://example.com/header-bg.jpg
style: molokai

projects:
  Category Name:
    Language:
      Project Name:
        link: https://github.com/user/project
        description: A brief description of your project
        complexity: 3

Minimal Example

name: Jane Doe
style: dark

projects:
  Web Development:
    React Dashboard:
      description: Modern admin panel
      complexity: 2

Advanced Example

name: John Smith
link: https://johnsmith.dev
logo: https://avatars.githubusercontent.com/u/12345
header_background: "linear-gradient(135deg, #667eea 0%, #764ba2 100%)"
style: molokai

projects:
  Operating Systems:
    C:
      kernel-module:
        link: https://github.com/user/kernel-module
        description: Custom Linux kernel module for performance monitoring
        complexity: 5

      bootloader:
        link: https://github.com/user/bootloader
        description: Minimal x86 bootloader
        complexity: 4

  Web Development:
    TypeScript:
      react-dashboard:
        link: https://github.com/user/dashboard
        description: Enterprise-grade admin dashboard
        complexity: 3

      api-gateway:
        description: Microservices API gateway (private repo)
        complexity: 4

  AI/ML:
    Python:
      sentiment-analyzer:
        link: https://github.com/user/sentiment
        description: Real-time sentiment analysis engine
        complexity: 3

🎯 Field Reference

Project Fields

💡 Examples

Header Backgrounds

# Solid color
header_background: "#667eea"

# Gradient
header_background: "linear-gradient(135deg, #667eea 0%, #764ba2 100%)"

# Remote image
header_background: https://images.unsplash.com/photo-1234567890

# Or wrap in url() manually
header_background: "url('https://example.com/image.jpg')"

Project Organization

# Direct projects under category
projects:
  Tools:
    cli-tool:
      link: https://github.com/user/tool
      description: Command-line utility
      complexity: 2

# Language-grouped projects
projects:
  Web Development:
    JavaScript:
      project-one:
        description: First project
        complexity: 2
      project-two:
        link: https://github.com/user/project-two
        description: Second project
        complexity: 3

🎪 Real-World Example

Check out iMil.yaml in this repository for a complete example featuring:

• Multiple categories (OS, AI, Misc)
• Language grouping (Go, NetBSD)
• Various projects with different complexity levels
• Molokai theme styling

And tadaa: iMil's FOSScard

🤸 Contributing

We love contributions! Whether it's:

• 🐛 Bug reports
• 💡 Feature requests
• 🎨 New themes
• 📝 Documentation improvements
• 🔧 Code contributions

How to contribute:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📜 License

This project is licensed under the WTFPL License - see the LICENSE file for details.

🎴 Made with ❤️ for the FOSS community

⬆ Back to Top