Skip to content

irampton/Schrune

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Schrune

Schrune is a small hardware description language for building schematics, PCB projects, and reusable part libraries for KiCad.

Install

npm install schrune

This package installs the schrune command.

Usage

schrune build path/to/design.schrune
schrune add C29823

Build

schrune build example3/example3.schrune

Build mode compiles a .schrune file, resolves parts, and writes KiCad output next to the source file:

  • KiCad/<name>.kicad_pro
  • KiCad/<name>.kicad_sch
  • KiCad/<name>.kicad_pcb
  • <name>.BOM.csv

Useful flags:

  • --keep-js writes the intermediate Step 1 JavaScript files
  • --no-parts-lock skips the autogenerated parts lock file

Add

schrune add C29823

add imports an LCSC part into the local parts/ tree. It requires the Python easyeda2kicad package to be available in a usable interpreter.

If you need to install that dependency into the current Python environment:

npm run setup:easyeda2kicad

If your system needs a specific interpreter, set EASYEDA2KICAD_PYTHON before running the setup script.

Syntax

See docs/syntax.md for the language reference and docs/cli.md for the CLI details.

About

A text-based PCB schmatic generator

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors