From 3a3be7183f3c2de9d4049191ca510fe4da7eece5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mark=20H=C3=A4mmerling?= Date: Wed, 7 Feb 2024 23:23:28 +0100 Subject: [PATCH 1/9] Refine doc intro --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1682b64..df0044c 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ 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. @@ -18,10 +18,10 @@ Back-propagation of modified component data to the schematic can be done in an e 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 (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 From fd53ddc13738c9199be8342c230a7f746f8025fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mark=20H=C3=A4mmerling?= Date: Wed, 7 Feb 2024 23:51:21 +0100 Subject: [PATCH 2/9] Refine doc --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index df0044c..51eda00 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Back-propagation of modified component data to the schematic can be done in an e The key concepts of KiVar are: - * Support for **multiple** independent variation aspects (dimensions, degrees of freedom) per design. + * 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. * Component values and attributes are modified **in place**, enabling compatibility with all exporters that work on the actual component data. From c29472836f28b84bee5f019e40f6122b6b553d55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mark=20H=C3=A4mmerling?= Date: Wed, 7 Feb 2024 23:55:47 +0100 Subject: [PATCH 3/9] Move source SVG to doc dir --- {assets => doc}/kivar-icon.inkscape.svg | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {assets => doc}/kivar-icon.inkscape.svg (100%) diff --git a/assets/kivar-icon.inkscape.svg b/doc/kivar-icon.inkscape.svg similarity index 100% rename from assets/kivar-icon.inkscape.svg rename to doc/kivar-icon.inkscape.svg From a1f66206a27e477567d4a9b2faf6459212d73970 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mark=20H=C3=A4mmerling?= Date: Thu, 8 Feb 2024 00:14:16 +0100 Subject: [PATCH 4/9] Test: Add icon --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 51eda00..e462db8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # KiVar − PCB Assembly Variant Selection for KiCad + + ## Introduction KiVar is a KiCad Action Plugin providing convenient PCB assembly variant selection. @@ -14,6 +16,8 @@ KiVar assigns component **values** and **attributes** (such as _Do not populate_ Back-propagation of modified component data to the schematic can be done in an extra step. +![KiVar icon](plugin/resources/icon.png) + ## Concepts The key concepts of KiVar are: From a88d8503180ebecd1da273ab52ecfaabc32dcb7a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mark=20H=C3=A4mmerling?= Date: Thu, 8 Feb 2024 00:16:53 +0100 Subject: [PATCH 5/9] Test img alignment --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e462db8..846e0ff 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,34 @@ # KiVar − PCB Assembly Variant Selection for KiCad - +
+ +
## Introduction +
+ +
+ 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. The plugin name _KiVar_ may be read as an acronym for _**Ki**Cad **V**ariation **a**ssignment **r**ules_. + + ## Features 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. -![KiVar icon](plugin/resources/icon.png) +![KiVar icon <](plugin/resources/icon.png) + +![KiVar icon >](plugin/resources/icon.png) + +![KiVar icon ><](plugin/resources/icon.png) ## Concepts From d2e4460d41939d72918e02f3016af896367723d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mark=20H=C3=A4mmerling?= Date: Thu, 8 Feb 2024 00:18:37 +0100 Subject: [PATCH 6/9] Test image alignment --- README.md | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) diff --git a/README.md b/README.md index 846e0ff..d83c316 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,21 @@ # KiVar − PCB Assembly Variant Selection for KiCad -
- -
+ ## Introduction -
- -
- 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. The plugin name _KiVar_ may be read as an acronym for _**Ki**Cad **V**ariation **a**ssignment **r**ules_. - - ## Features 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. -![KiVar icon <](plugin/resources/icon.png) - -![KiVar icon >](plugin/resources/icon.png) - -![KiVar icon ><](plugin/resources/icon.png) - ## Concepts The key concepts of KiVar are: From 43eabc3e71ff0e67113e73222c19522933237555 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mark=20H=C3=A4mmerling?= Date: Thu, 8 Feb 2024 00:24:11 +0100 Subject: [PATCH 7/9] Align image --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d83c316..4d8b4e8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# KiVar − PCB Assembly Variant Selection for KiCad - +# KiVar − PCB Assembly Variants for KiCad + ## Introduction KiVar is a KiCad Action Plugin providing convenient PCB assembly variant selection. From 2a497888ca350e9c71c516e450db49ec4645910f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mark=20H=C3=A4mmerling?= Date: Thu, 8 Feb 2024 00:29:30 +0100 Subject: [PATCH 8/9] Use the Inkscape SVG as Readme icon --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d8b4e8..287dc6f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - + # KiVar − PCB Assembly Variants for KiCad From a0b2e43c4fc26cee3b90b70aeed9d6a3187f3c75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mark=20H=C3=A4mmerling?= Date: Thu, 8 Feb 2024 00:38:53 +0100 Subject: [PATCH 9/9] Move icon down --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 287dc6f..c6b2a49 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - - # KiVar − PCB Assembly Variants for KiCad ## Introduction + + 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.