Skip to content

README_GITHUB.md

Latest commit

 

History

History
86 lines (59 loc) · 1.96 KB

README_GITHUB.md

File metadata and controls

86 lines (59 loc) · 1.96 KB

🚀 CURSY Framework - GitHub Setup

Everything is Ready! ✅

The repository is initialized and all files are staged! Here's what to do:

Quick Setup ⚡

Step 1: Configure Git (If not already done)

git config --global user.email "your@email.com"
git config --global user.name "Your Name"

Step 2: Create GitHub Repository

  1. Go to https://github.com/new
  2. Repository name: CURSY-Framework
  3. Description: A hand-crafted, synthwave/cyberpunk CSS framework - The Bulma/Tailwind killer!
  4. Choose Public or Private
  5. DON'T initialize with README (we already have one!)
  6. Click "Create repository"

Step 3: Push to GitHub

Option A: Use the script (Easiest!)

.\PUSH_TO_GITHUB.ps1

Option B: Manual commands

git remote add origin https://github.com/[your-username]/CURSY-Framework.git
git branch -M main
git commit -m "Initial commit: CURSY Framework v0.420a"
git push -u origin main

Step 4: Enable GitHub Pages

  1. Go to your repository on GitHub
  2. Settings → Pages
  3. Source: Deploy from a branch
  4. Branch: main
  5. Folder: /docs
  6. Click Save

Step 5: Wait for Deployment

  • Check the Actions tab for deployment status
  • Your site will be live at: https://[your-username].github.io/CURSY-Framework/

What's Included 📦

  • ✅ 30+ Components (buttons, cards, forms, alerts, modals, tabs, etc.)
  • ✅ 200+ Utility Classes (spacing, colors, typography, layout)
  • ✅ GitHub Pages Website (docs/index.html)
  • ✅ Auto-Deploy Workflow (.github/workflows/pages.yml)
  • ✅ Complete Documentation

Files Ready to Push 📁

All files are staged and ready:

  • CSS framework files
  • Documentation
  • GitHub Pages website
  • Workflow files
  • License and package.json

Need Help? 💖

Check SETUP_GITHUB.md for detailed instructions!

CURSY Framework v0.420a · Ready to launch! 🚀 🚗💖✨