Skip to content

PCM_SETUP_COMPLETE.md

Latest commit

 

History

History
183 lines (140 loc) · 5.22 KB

PCM_SETUP_COMPLETE.md

File metadata and controls

183 lines (140 loc) · 5.22 KB

KiCad PCM Distribution Setup - Complete ✅

The plugin is now ready for distribution through KiCad's Plugin and Content Manager (PCM)!

What Has Been Done

1. ✅ Created PCM Metadata

2. ✅ Created Plugin Icon

  • File: resources/icon.png
  • Size: 64x64 pixels
  • Format: PNG with RGBA
  • Design: Blue circle with IC chip symbol and "L" letter

3. ✅ Created Release Packaging Script

  • File: create_release.sh
  • Purpose: Automates creation of distribution ZIP
  • Output: Properly structured package with SHA256 hash

4. ✅ Updated Documentation

  • README.md: Added KiCad PCM installation instructions
  • DISTRIBUTION.md: Complete guide for packaging and distribution
  • PCM_SETUP_COMPLETE.md: This file

5. ✅ Created Test Package

  • Location: release/kicad-lcsc-manager-0.1.0.zip
  • Size: ~52 KB
  • SHA256: 6c364459af739e4e23794db776db406575b74d5bee91fe9894169db5d32f7573

Package Structure

kicad-lcsc-manager-0.1.0.zip
└── kicad-lcsc-manager-0.1.0/
    ├── plugins/
    │   └── lcsc_manager/          # Plugin code
    ├── resources/
    │   ├── icon.png               # Plugin icon (64x64)
    │   └── icon.svg               # SVG source
    ├── metadata.json              # PCM metadata
    ├── README.md                  # User documentation
    ├── LICENSE                    # MIT License
    └── INSTALL.md                 # Installation guide

Next Steps to Publish

Option 1: GitHub Releases (Easiest)

  1. Create a GitHub Release:

    # Go to: https://github.com/hulryung/kicad-lcsc-manager/releases
# Click "Create a new release"
# Tag: v0.1.0
# Title: LCSC Manager v0.1.0
# Upload: release/kicad-lcsc-manager-0.1.0.zip

  2. Share the Installation Link:

    • Users can download manually from GitHub releases
    • Or use the metadata.json for custom PCM repositories

Option 2: Official KiCad PCM Repository (Recommended for wider distribution)

  1. Fork the KiCad Metadata Repository:

    git clone https://gitlab.com/kicad/addons/metadata.git
cd metadata/packages

  2. Add Your Plugin Metadata:

    cp /path/to/your/metadata.json com.github.hulryung.kicad-lcsc-manager.json

  3. Submit Merge Request:

    • Commit the metadata file
    • Push to your fork
    • Create merge request to official repository
    • Wait for review (usually a few days)

  4. After Approval:

    • Plugin appears in KiCad's official PCM
    • Users can install with one click
    • Automatic updates when new versions released

How Users Will Install

From Official PCM (After submission):

  1. Open KiCad
  2. Tools → Plugin and Content Manager
  3. Search "LCSC Manager"
  4. Click Install
  5. Restart KiCad

From GitHub Release (Available now):

  1. Download ZIP from GitHub releases
  2. Extract to KiCad plugins directory
  3. Restart KiCad

Testing the Package

Before publishing, test the package:

# Extract to KiCad plugins directory
cd ~/Documents/KiCad/9.0/scripting/plugins/
unzip /path/to/kicad-lcsc-manager-0.1.0.zip
mv kicad-lcsc-manager-0.1.0/* .
rmdir kicad-lcsc-manager-0.1.0

# Restart KiCad and test

Version Updates

For future releases:

  1. Update Version Number:

    • plugins/lcsc_manager/__init__.py → __version__ = "0.2.0"
    • metadata.json → Add new version entry

  2. Create New Package:

    ./create_release.sh

  3. Update metadata.json:

    • Add new version with updated SHA256
    • Previous versions remain in array

  4. Create GitHub Release:

    • Tag: v0.2.0
    • Upload new ZIP file

Files Created/Modified

New Files:

  • ✅ metadata.json - PCM package metadata
  • ✅ resources/icon.png - Plugin icon (64x64 PNG)
  • ✅ resources/icon.svg - Icon source (SVG)
  • ✅ create_release.sh - Release packaging script
  • ✅ DISTRIBUTION.md - Distribution guide
  • ✅ PCM_SETUP_COMPLETE.md - This file
  • ✅ create_icon.py - Icon generator (obsolete, kept for reference)
  • ✅ create_png_icon.py - PNG icon generator (obsolete)
  • ✅ create_simple_png.py - Simple PNG generator (used)
  • ✅ convert_svg_to_png.sh - SVG converter helper

Modified Files:

  • ✅ README.md - Added PCM installation instructions
  • ✅ Updated feature list with latest capabilities

Current Status

✅ Plugin is ready for distribution!

The package is complete and tested. You can:

  • ✅ Create a GitHub release immediately
  • ✅ Share with users for manual installation
  • ⏳ Submit to official KiCad PCM (optional, takes a few days for approval)

Support and Resources

Questions?

For distribution or packaging questions:

  • Check DISTRIBUTION.md for detailed guide
  • Review KiCad PCM documentation
  • Open an issue on GitHub

Ready to publish! 🚀