Updated README.md and YAML example

This commit is contained in:
SET 2020-08-12 12:02:43 -03:00
parent 51802aa42b
commit 303bfb38fb
2 changed files with 8 additions and 2 deletions

View File

@ -374,6 +374,8 @@ Next time you need this list just use an alias, like this:
regex: 'mount.*hole'
- column: Part
regex: 'solder.*bridge'
- column: Part
regex: 'solder.*jump'
- column: Part
regex: 'test.*point'
- column: Footprint
@ -421,7 +423,8 @@ Next time you need this list just use an alias, like this:
- `merge_blank_fields`: [boolean=true] Component groups with blank fields will be merged into the most compatible group, where possible.
- `number`: [number=1] Number of boards to build (components multiplier).
- `output`: [string='%f-%i.%x'] filename for the output (%i=bom). Affected by global options.
- `test_regex`: [boolean=true] Each component group will be tested against a number of regular-expressions (see ``)..
- `test_regex`: [boolean=true] Each component group will be tested against a number of regular-expressions
(see `include_only` and `exclude_any`).
- `use_alt`: [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18.
- `variant`: [string=''] Board variant(s), used to determine which components
are output to the BoM..

View File

@ -74,6 +74,8 @@ outputs:
# - column: Part
# ..regex: 'solder.*bridge'
# - column: Part
# ..regex: 'solder.*jump'
# - column: Part
# ..regex: 'test.*point'
# - column: Footprint
# ..regex 'test.*point'
@ -142,7 +144,8 @@ outputs:
number: 1
# [string='%f-%i.%x'] filename for the output (%i=bom). Affected by global options
output: '%f-%i.%x'
# [boolean=true] Each component group will be tested against a number of regular-expressions (see ``).
# [boolean=true] Each component group will be tested against a number of regular-expressions
# (see `include_only` and `exclude_any`)
test_regex: true
# [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18
use_alt: false