Skip to content

A Ruby command-line tool that scaffolds a clean, organized, and best-practice KiCad PCB project directory, including schematics, PCB layout, libraries, BOM, manufacturing files, and firmware folders.

Notifications You must be signed in to change notification settings

ColTheDeveloper/pcb-init

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

pcb-init

A Ruby CLI tool that scaffolds a best-practice KiCad PCB project structure.

Installation

gem install pcb-init

Usage

pcb-init PROJECT_NAME

Example

pcb-init my-awesome-board

This will create a well-organized folder structure:

my-awesome-board/
├── README.md
├── docs/
│   └── changelog.md
├── schematic/
├── pcb/
│   └── design_rules.md
├── libraries/
│   ├── symbols/
│   ├── footprints/
│   └── 3d_models/
├── bom/
├── manufacturing/
│   ├── gerbers/
│   ├── drill/
│   ├── pick_and_place/
│   └── panel/
├── assembly/
├── images/
├── revisions/
│   └── rev_A/
├── firmware/
│   ├── source/
│   └── binaries/
└── .gitignore

Features

  • Clean, organized folder structure following PCB project best practices
  • Pre-configured .gitignore for KiCad and manufacturing files
  • Ready-to-use templates for documentation
  • No external dependencies (pure Ruby)

Requirements

  • Ruby ≥ 3.0

License

MIT

About

A Ruby command-line tool that scaffolds a clean, organized, and best-practice KiCad PCB project directory, including schematics, PCB layout, libraries, BOM, manufacturing files, and firmware folders.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages