diff --git a/README.md b/README.md index 0ee012b0..84300aa3 100644 --- a/README.md +++ b/README.md @@ -330,6 +330,9 @@ Next time you need this list just use an alias, like this: * Description: Used to generate the BoM in CSV, HTML, TSV, TXT, XML or XLSX format using the internal BoM. Is compatible with KiBoM, but doesn't need to update the XML netlist because the components are loaded from the schematic. + Important differences with KiBoM output: + - All options are in the main `options` section, not in `conf` subsection. + - The `Component` column is named `Row` and works just like any other column. This output is what you get from the 'Tools/Generate Bill of Materials' menu in eeschema. * Valid keys: - `comment`: [string=''] A comment for documentation purposes. @@ -402,7 +405,6 @@ Next time you need this list just use an alias, like this: - *regexp*: Alias for regex. - `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). - - `number_rows`: [boolean=true] First column is the row number. - `output`: [string='%f-%i.%x'] filename for the output (%i=bom). Affected by global options. - `separator`: [string=','] CSV Separator. - `test_regex`: [boolean=true] Each component group will be tested against a number of regular-expressions (see ``).. diff --git a/docs/samples/generic_plot.kiplot.yaml b/docs/samples/generic_plot.kiplot.yaml index 94742755..8318fb0e 100644 --- a/docs/samples/generic_plot.kiplot.yaml +++ b/docs/samples/generic_plot.kiplot.yaml @@ -22,6 +22,9 @@ outputs: # BoM (Bill of Materials): # Is compatible with KiBoM, but doesn't need to update the XML netlist because the components # are loaded from the schematic. + # Important differences with KiBoM output: + # - All options are in the main `options` section, not in `conf` subsection. + # - The `Component` column is named `Row` and works just like any other column. # This output is what you get from the 'Tools/Generate Bill of Materials' menu in eeschema. - name: 'bom_example' comment: 'Used to generate the BoM in CSV, HTML, TSV, TXT, XML or XLSX format using the internal BoM.' @@ -113,8 +116,6 @@ outputs: merge_blank_fields: true # [number=1] Number of boards to build (components multiplier) number: 1 - # [boolean=true] First column is the row number - number_rows: true # [string='%f-%i.%x'] filename for the output (%i=bom). Affected by global options output: '%f-%i.%x' # [string=','] CSV Separator