Skip to content

Commit

Permalink
Merge pull request #19 from markh-de/doc-refine-intro
Browse files Browse the repository at this point in the history
Doc refine intro
  • Loading branch information
markh-de authored Feb 7, 2024
2 parents 9a6e3ed + a0b2e43 commit a4da221
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# KiVar − PCB Assembly Variant Selection for KiCad
# KiVar − PCB Assembly Variants for KiCad

## Introduction

<img align='right' width='92' src='doc/kivar-icon.inkscape.svg'>

KiVar is a KiCad Action Plugin providing convenient PCB assembly variant selection.

Component variations are specified by rules defined in dedicated symbol or footprint fields. This allows for the complete variant configuration to be contained in the schematic and board files without requiring external data from outside the native KiCad design files.
Expand All @@ -10,18 +12,18 @@ The plugin name _KiVar_ may be read as an acronym for _**Ki**Cad **V**ariation *

## Features

KiVar assigns component **values** and **attributes** (such as _Do not populate_), depending on the selection of variation rules specified in footprint fields. Component values and attributes are modified _in place_, allowing for immediate update of the PCB design as well as the 3D view and enabling compatibility with _any_ exporter.
KiVar assigns component **values** and **attributes** (such as _Do not populate_) according to variation rules specified in footprint fields. Component values and attributes are modified _in place_, allowing for immediate update of the PCB design as well as the 3D view and enabling compatibility with _any_ exporter.

Back-propagation of modified component data to the schematic can be done in an extra step.

## Concepts

The key concepts of KiVar are:

* Support for **multiple** independent variation aspects (i.e. dimensions or aspects of freedom) per design.
* Component values and attributes are modified **in place**, allowing exporters to work on the actual component data.
* Support for **multiple** independent variation aspects (i.e., dimensions, degrees of freedom) per design.
* Variation rules are **fully contained** in symbol/footprint fields of native design files (no external configuration files) and **portable** (copying components to another design keeps their variation specification intact).
* **Seamless integration** of the choice selection process, giving the impression of a native KiCad feature.
* Variation rules are **fully contained** in symbol/footprint fields (i.e., zero configuration outside the native design files) and hence **portable** (i.e., parts of a schematic or board design containing variation rules can be copied to another design while keeping their variation specification intact).
* Component values and attributes are modified **in place**, enabling compatibility with all exporters that work on the actual component data.

## Supported KiCad Versions

Expand Down
File renamed without changes

0 comments on commit a4da221

Please sign in to comment.