Skip to content

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

 
 
 

Contributors

Languages